Skip to content

Latest commit

 

History

History
33 lines (18 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

33 lines (18 loc) · 1.17 KB

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.

Pull Requests

In order for your Pull Request to be merged, please ensure it meets the following criteria:

  • Standard JS coding style - Make sure you run npm run lint before committing your code.

  • Add specs where appropriate - Mocha, Should

  • Document any change in behaviour - 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.

Running Specs

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

npm test