How to contribute

Pull requests!

Getting Started

Make sure you have a GitHub account
Fork the repository on GitHub

Making Changes

Create a topic branch from where you want to base your work.
- This is always the master branch.
- e.g. git checkout -b my_fix
- Please avoid working directly on the master branch.
Make commits of logical units.
Check for unnecessary whitespace with git diff --check before committing.
Reasonably describe your commits in your commit message.
Make sure you have added the necessary tests for your changes.
Run all the tests to assure nothing else was accidentally broken.
- npm test

Submitting Changes

Push your changes to a topic branch in your fork of the repository.
- git push origin my_fix
Submit a pull request

Additional Resources