You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

14 lines
927 B

  1. # Contributing to Gomega
  2. Your contributions to Gomega are essential for its long-term maintenance and improvement. To make a contribution:
  3. - Please **open an issue first** - describe what problem you are trying to solve and give the community a forum for input and feedback ahead of investing time in writing code!
  4. - Ensure adequate test coverage:
  5. - Make sure to add appropriate unit tests
  6. - Please run all tests locally (`ginkgo -r -p`) and make sure they go green before submitting the PR
  7. - Please run following linter locally `go vet ./...` and make sure output does not contain any warnings
  8. - Update the documentation. In addition to standard `godoc` comments Gomega has extensive documentation on the `gh-pages` branch. If relevant, please submit a docs PR to that branch alongside your code PR.
  9. If you're a committer, check out RELEASING.md to learn how to cut a release.
  10. Thanks for supporting Gomega!