Skip to content
This repository has been archived by the owner on Mar 30, 2022. It is now read-only.

Latest commit

 

History

History
35 lines (20 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

35 lines (20 loc) · 1.46 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Issues

  • Feature requests need to describe as thoroughly as possible and perhaps contain some info on how you would implement it
  • Bug reports need to be described in detail what the problem is, how it was triggered and perhaps contain a possible solution
  • Questions are free to be asked about the internals of the codebase and about the project

Pull Requests

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • Create feature branches - Don't ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

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

All tests can be run with the following commands.

yarn test

Happy coding!