Contributing

Contributions are welcome!

Contributions can be made via a Pull Request on Github.

Reporting an Issue

Please report issues via the issue tracker on Github. For security-related issues, please email the maintainer directly.

Node.js coding style - JSCS, JSHint. Make sure you run npm run sa before committing your code.
Add tests where appropriate - Mocha, Chai
Document any change in behavior - Make sure the README and any other relevant documentation are kept up-to-date.
Create topic branches - i.e feature/some-awesome-feature.
One pull request per feature
Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
Use conventional-changelog style commit messages - See here for more details. This project is commitizen friendly.

You can run all of the tests in the project using:

npm test

You can run all of the static analysis tools used by the project using:

npm run sa