Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.52 KB
Raw

Contributing

We are happy to accept any contributions that make sense and respect the rules listed below.

How to contribute

  1. Fork the repo.
  2. 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.
  3. Implement your contribution while respecting our rules (see below).
  4. Run npm test to make sure you didn't break anything.
  5. Add tests for your contribution so that no one else will break it.
  6. Submit a pull request against our develop branch!

Rules

  • 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.

License

By contributing your code, you agree to license your contribution under our LICENSE.