Everyone is very welcome to contribute to this project. You can contribute just by submitting bugs or suggesting improvements by opening an issue on GitHub.
You can also submit PRs but please adhere with the code standards and write tests for the proposed changes.
- Create a fork of the repository
- Run
npm installto install the dependencies (will download also the dev dependencies) - Create a specific git branch giving it a descriptive name of the feature you want to work on
- Edit the code
- Write tests
- Run the test suit with
npm test(will check also code style and report coverage) - If everything seems ok submit the pull request
The current code standard used in this project is airbnb with with 2 small variation:
- Camel case identifiers are not mandatory
- anonymous functions are disabled (I believe it's better for debugging).
The project uses jscs, so you can use ./node_modules/.bin/jscs lib/ tests/ bin/ to check the code standards.