WIP on possible new format for README
This commit is contained in:
deadprogram
parent
f3cbbe8ad7
commit
7581dc3c64
|
|
@ -0,0 +1,91 @@
|
||||||
|
# Contributing to Cylon.js
|
||||||
|
|
||||||
|
## Issue Contributions
|
||||||
|
|
||||||
|
When opening new issues or commenting on existing issues on this repository
|
||||||
|
please make sure discussions are related to concrete technical issues with the
|
||||||
|
Cylon.js software.
|
||||||
|
|
||||||
|
## Code Contributions
|
||||||
|
|
||||||
|
The Cylon.js project welcomes new contributors.
|
||||||
|
|
||||||
|
This document will guide you through the contribution process.
|
||||||
|
|
||||||
|
What do you want to contribute?
|
||||||
|
|
||||||
|
- I want to otherwise correct or improve the docs or examples
|
||||||
|
- I want to report a bug
|
||||||
|
- I want to add some feature or functionality to an existing hardware platform
|
||||||
|
- I want to add support for a new hardware platform
|
||||||
|
|
||||||
|
Descriptions for each of these will be provided below.
|
||||||
|
|
||||||
|
## General Guidelines
|
||||||
|
|
||||||
|
* All patches must be provided under the Apache 2.0 License
|
||||||
|
* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
|
||||||
|
* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
|
||||||
|
* We will look at the patch, test it out, and give you feedback.
|
||||||
|
* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
|
||||||
|
* Take care to maintain the existing coding style.
|
||||||
|
* Add unit tests for any new or changed functionality & lint and test your code using `make test` and `make lint`.
|
||||||
|
* All pull requests should be "fast forward"
|
||||||
|
* If there are commits after yours use `git rebase -i <new_head_branch>`
|
||||||
|
* If you have local changes you may need to use `git stash`
|
||||||
|
* For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
|
||||||
|
|
||||||
|
|
||||||
|
## Developer's Certificate of Origin 1.0
|
||||||
|
|
||||||
|
By making a contribution to this project, I certify that:
|
||||||
|
|
||||||
|
* (a) The contribution was created in whole or in part by me and I
|
||||||
|
have the right to submit it under the open source license indicated
|
||||||
|
in the file; or
|
||||||
|
* (b) The contribution is based upon previous work that, to the best
|
||||||
|
of my knowledge, is covered under an appropriate open source license
|
||||||
|
and I have the right under that license to submit that work with
|
||||||
|
modifications, whether created in whole or in part by me, under the
|
||||||
|
same open source license (unless I am permitted to submit under a
|
||||||
|
different license), as indicated in the file; or
|
||||||
|
* (c) The contribution was provided directly to me by some other
|
||||||
|
person who certified (a), (b) or (c) and I have not modified it.
|
||||||
|
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from [Rust's wonderful
|
||||||
|
CoC](http://www.rust-lang.org/conduct.html).
|
||||||
|
|
||||||
|
* We are committed to providing a friendly, safe and welcoming
|
||||||
|
environment for all, regardless of gender, sexual orientation,
|
||||||
|
disability, ethnicity, religion, or similar personal characteristic.
|
||||||
|
* Please avoid using overtly sexual nicknames or other nicknames that
|
||||||
|
might detract from a friendly, safe and welcoming environment for
|
||||||
|
all.
|
||||||
|
* Please be kind and courteous. There's no need to be mean or rude.
|
||||||
|
* Respect that people have differences of opinion and that every
|
||||||
|
design or implementation choice carries a trade-off and numerous
|
||||||
|
costs. There is seldom a right answer.
|
||||||
|
* Please keep unstructured critique to a minimum. If you have solid
|
||||||
|
ideas you want to experiment with, make a fork and see how it works.
|
||||||
|
* We will exclude you from interaction if you insult, demean or harass
|
||||||
|
anyone. That is not welcome behaviour. We interpret the term
|
||||||
|
"harassment" as including the definition in the [Citizen Code of
|
||||||
|
Conduct](http://citizencodeofconduct.org/); if you have any lack of
|
||||||
|
clarity about what might be included in that concept, please read
|
||||||
|
their definition. In particular, we don't tolerate behavior that
|
||||||
|
excludes people in socially marginalized groups.
|
||||||
|
* Private harassment is also unacceptable. No matter who you are, if
|
||||||
|
you feel you have been or are being harassed or made uncomfortable
|
||||||
|
by a community member, please contact one of the channel ops or any
|
||||||
|
of the TC members immediately with a capture (log, photo, email) of
|
||||||
|
the harassment if possible. Whether you're a regular contributor or
|
||||||
|
a newcomer, we care about making this community a safe place for you
|
||||||
|
and we've got your back.
|
||||||
|
* Likewise any spamming, trolling, flaming, baiting or other
|
||||||
|
attention-stealing behaviour is not welcome.
|
||||||
|
* Avoid the use of personal pronouns in code comments or
|
||||||
|
documentation. There is no need to address persons when explaining
|
||||||
|
code (e.g. "When the developer")
|
||||||
|
|
@ -329,61 +329,15 @@ If you want to help with documentation, you can find the code for our website at
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
* All patches must be provided under the Apache 2.0 License
|
For our contribution guidelines, please go to [https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md
|
||||||
* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
|
](https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md
|
||||||
* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
|
).
|
||||||
* We will look at the patch, test it out, and give you feedback.
|
|
||||||
* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
|
|
||||||
* Take care to maintain the existing coding style.
|
|
||||||
* Add unit tests for any new or changed functionality & lint and test your code using `make test` and `make lint`.
|
|
||||||
* All pull requests should be "fast forward"
|
|
||||||
* If there are commits after yours use “git rebase -i <new_head_branch>”
|
|
||||||
* If you have local changes you may need to use “git stash”
|
|
||||||
* For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
|
|
||||||
|
|
||||||
## Release History
|
## Release History
|
||||||
|
|
||||||
Version | Notes
|
For the release history, please go to [https://github.com/hybridgroup/cylon/blob/master/RELEASES.md
|
||||||
------- | -----
|
](https://github.com/hybridgroup/cylon/blob/master/RELEASES.md
|
||||||
1.0.0 | Remove deprecated Device and Connection syntax, add Basestar#respond method
|
).
|
||||||
0.22.2 | Bug-fix for Registry loader
|
|
||||||
0.22.1 | Remove lodash, misc. bug fixes
|
|
||||||
0.22.0 | API extraction, new devices syntax.
|
|
||||||
0.21.2 | Update Robeaux version
|
|
||||||
0.21.1 | Add back debug logging for starting/connecting devices/connections
|
|
||||||
0.21.0 | Remove Connection/Device objects, update Robot connection/device syntax, fluent syntax updates
|
|
||||||
0.20.2 | Correct API issues, possible issue with test setups
|
|
||||||
0.20.1 | Revert accidental scrict handling of param in driver initializer
|
|
||||||
0.20.0 | Browser support, new module loading, log level support, misc. development changes
|
|
||||||
0.19.1 | Correct issue with dynamic method proxying
|
|
||||||
0.19.0 | Fluent syntax, improved start/halt, various other updates
|
|
||||||
0.18.0 | Updates Robot and Driver commands structure
|
|
||||||
0.17.0 | Updates to API to match CPPP-IO spec
|
|
||||||
0.16.0 | New IO Utils, removal of Utils#bind, add Adaptor#_noop method.
|
|
||||||
0.15.1 | Fixed issue with the API on Tessel
|
|
||||||
0.15.0 | Better halting, cleaner startup, removed 'connect' and 'start' events, and misc other cleanups/refactors.
|
|
||||||
0.14.0 | Removal of node-namespace and misc. cleanup
|
|
||||||
0.13.3 | Fixes bug with disconnect functions not being called.
|
|
||||||
0.13.2 | Use pure Express, adds server-sent-events, upd API.
|
|
||||||
0.13.1 | Add API authentication and HTTPS support
|
|
||||||
0.13.0 | Set minimum Node version to 0.10.20, add utils to global namespace and improve initialization routines
|
|
||||||
0.12.0 | Extraction of CLI tooling
|
|
||||||
0.11.2 | bugfixes
|
|
||||||
0.11.0 | Refactor into pure JavaScript
|
|
||||||
0.10.4 | Add JS helper functions
|
|
||||||
0.10.3 | Fix dependency issue
|
|
||||||
0.10.2 | Create connections convenience vars, refactor config loading
|
|
||||||
0.10.1 | Updates required for test driven robotics, update Robeaux version, bugfixes
|
|
||||||
0.10.0 | Use Robeaux UX, add CLI commands for helping connect to devices, bugfixes
|
|
||||||
0.9.0 | Add AngularJS web interface to API, extensible commands for CLI
|
|
||||||
0.8.0 | Refactored Adaptor and Driver into proper base classes for easier authoring of new modules
|
|
||||||
0.7.0 | cylon command for generating new adaptors, support code for better GPIO support, literate examples
|
|
||||||
0.6.0 | API exposes robot commands, fixes issues in driver/adaptor init
|
|
||||||
0.5.0 | Improve API, add GPIO support for reuse in adaptors
|
|
||||||
0.4.0 | Refactor proxy in Cylon.Basestar, improve API
|
|
||||||
0.3.0 | Improved Cylon.Basestar, and added API
|
|
||||||
0.2.0 | Cylon.Basestar to help develop external adaptors/drivers
|
|
||||||
0.1.0 | Initial release for ongoing development
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,43 @@
|
||||||
|
## Release History
|
||||||
|
|
||||||
|
Version | Notes
|
||||||
|
------- | -----
|
||||||
|
1.0.0 | Remove deprecated Device and Connection syntax, add Basestar#respond method
|
||||||
|
0.22.2 | Bug-fix for Registry loader
|
||||||
|
0.22.1 | Remove lodash, misc. bug fixes
|
||||||
|
0.22.0 | API extraction, new devices syntax.
|
||||||
|
0.21.2 | Update Robeaux version
|
||||||
|
0.21.1 | Add back debug logging for starting/connecting devices/connections
|
||||||
|
0.21.0 | Remove Connection/Device objects, update Robot connection/device syntax, fluent syntax updates
|
||||||
|
0.20.2 | Correct API issues, possible issue with test setups
|
||||||
|
0.20.1 | Revert accidental scrict handling of param in driver initializer
|
||||||
|
0.20.0 | Browser support, new module loading, log level support, misc. development changes
|
||||||
|
0.19.1 | Correct issue with dynamic method proxying
|
||||||
|
0.19.0 | Fluent syntax, improved start/halt, various other updates
|
||||||
|
0.18.0 | Updates Robot and Driver commands structure
|
||||||
|
0.17.0 | Updates to API to match CPPP-IO spec
|
||||||
|
0.16.0 | New IO Utils, removal of Utils#bind, add Adaptor#_noop method.
|
||||||
|
0.15.1 | Fixed issue with the API on Tessel
|
||||||
|
0.15.0 | Better halting, cleaner startup, removed 'connect' and 'start' events, and misc other cleanups/refactors.
|
||||||
|
0.14.0 | Removal of node-namespace and misc. cleanup
|
||||||
|
0.13.3 | Fixes bug with disconnect functions not being called.
|
||||||
|
0.13.2 | Use pure Express, adds server-sent-events, upd API.
|
||||||
|
0.13.1 | Add API authentication and HTTPS support
|
||||||
|
0.13.0 | Set minimum Node version to 0.10.20, add utils to global namespace and improve initialization routines
|
||||||
|
0.12.0 | Extraction of CLI tooling
|
||||||
|
0.11.2 | bugfixes
|
||||||
|
0.11.0 | Refactor into pure JavaScript
|
||||||
|
0.10.4 | Add JS helper functions
|
||||||
|
0.10.3 | Fix dependency issue
|
||||||
|
0.10.2 | Create connections convenience vars, refactor config loading
|
||||||
|
0.10.1 | Updates required for test driven robotics, update Robeaux version, bugfixes
|
||||||
|
0.10.0 | Use Robeaux UX, add CLI commands for helping connect to devices, bugfixes
|
||||||
|
0.9.0 | Add AngularJS web interface to API, extensible commands for CLI
|
||||||
|
0.8.0 | Refactored Adaptor and Driver into proper base classes for easier authoring of new modules
|
||||||
|
0.7.0 | cylon command for generating new adaptors, support code for better GPIO support, literate examples
|
||||||
|
0.6.0 | API exposes robot commands, fixes issues in driver/adaptor init
|
||||||
|
0.5.0 | Improve API, add GPIO support for reuse in adaptors
|
||||||
|
0.4.0 | Refactor proxy in Cylon.Basestar, improve API
|
||||||
|
0.3.0 | Improved Cylon.Basestar, and added API
|
||||||
|
0.2.0 | Cylon.Basestar to help develop external adaptors/drivers
|
||||||
|
0.1.0 | Initial release for ongoing development
|
||||||
11
package.json
11
package.json
|
|
@ -23,6 +23,17 @@
|
||||||
|
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
|
|
||||||
|
"keywords": [
|
||||||
|
"cylon",
|
||||||
|
"cylonjs",
|
||||||
|
"cylons",
|
||||||
|
"robot"
|
||||||
|
"robots"
|
||||||
|
"robotics",
|
||||||
|
"iot",
|
||||||
|
"hardware"
|
||||||
|
],
|
||||||
|
|
||||||
"hardware": {
|
"hardware": {
|
||||||
"*": false,
|
"*": false,
|
||||||
"./": false,
|
"./": false,
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue