We are happy to accept any contributions that make sense and respect the rules listed below.
- Fork the repo.
- Create a feature branch for your contribution out of the
develop
branch. We use the git-flow tool to implement the successful Git branching model. Only one contribution per branch is accepted. - Implement your contribution while respecting our rules (see below).
- Run
npm test
to make sure you didn't break anything. - Add tests for your contribution so that no one else will break it.
- Submit a pull request against our
develop
branch!
- Do use feature branches.
- Do conform to existing coding style so that your contribution fits in.
- Do use EditorConfig to enforce our whitespace rules. If your editor is not supported, enforce the settings manually.
- Do run
npm test
for CoffeeLint, JSONLint and unit test coverage. - Do not touch the
version
field in package.json. - Do not commit any generated files, unless already in the repo. If absolutely necessary, explain why.
- Do not create any top level files or directories. If absolutely necessary, explain why and update .npmignore.
By contributing your code, you agree to license your contribution under our LICENSE.