Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

29 lines (16 loc) · 1.35 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

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

  • Try to cover everything - Ensure that you got all your new code covered or, if you can't, try to explain why on your pull request.

  • Update the changelog - Make sure the CHANGELOG.md is up-to-date. Follow the example and good practices in the Keep a Changelog site. If you change some main behavior, be sure to also update the README.md file.

  • 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

pnpm test:coverage

Thank you and happy coding!