Contributing Guide

Contributions are always welcome, no matter how big or small. Like most sane projects, we strive for forwards compatibility, however, if changes are merited, they will be made. Before contributing, please read the code of conduct.


If you have a question that does not appear to be an issue with the repository (e.g. not sure how to set up or use). Please reach out our Gitter chatroom. You can always find it in the README as the Join the chat at button.

Pull Requests

Pull requests are always welcomed. Before submitting a pull request, however, please make sure you have done the following things:

  1. Fork the repo and create your branch from master
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, try to write documentation.
  4. Write a complete pull request description documenting the changes you've made, API changes, etc.