Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 2.6 KB
Raw

How to contribute

Did you find a bug? 🐞

  • 🔎 Please ensure your findings have not already been reported by searching on the project repository under Issues.
  • If you think your findings can be complementary to an existing issue, don't hesitate to join the conversation 😃☕
  • If there's no issue addressing the problem, open a new one. Please be clear in the title and description, and add relevant information. Bonus points if you provide a code sample and everything needed to reproduce the issue when expected behaviour is not occurring.
  • If possible, use the relevant issue templates.

Do you have a fix?

🎉 That's awesome! Pull requests are welcome!

  • Please open an issue beforehand, so we can discuss this.
  • Fork this repo from main, and ensure your fork is up-to-date with it when submitting the PR.
  • If your changes impact the documentation, please update it accordingly.
  • If you added code that impact tests, please add tests with relevant coverage and test cases. Bonus points for fuzzing.
  • 🛠️ Make sure the test suite passes.

If your changes might have an impact on performance, please benchmark your code and measure the impact, share the results and the tests that lead to these results.

Please note that changes that are purely cosmetic and do not add anything substantial to the stability, functionality, or testability of the project may not be accepted.

Coding Convention

This project tries to be as Go idiomatic as possible. Conventions from Effective Go apply here. Tests use a very opinionated linting configuration that you should use before committing to your changes.

Governance Model

This project follows the Benevolent Dictator Governance Model where the project owner and lead makes all final decisions.

Licence

By contributing to this project, you agree that your contributions will be licensed under the project's License.

All contributions (including pull requests) must agree to the Developer Certificate of Origin (DCO) version 1.1. It states that the contributor has the right to submit the patch for inclusion into the project. Simply submitting a contribution implies this agreement, however, please include the "Signed-off-by" git tag in every commit (this tag is a conventional way to confirm that you agree to the DCO).

Thanks! ❤️