1# Contributing to Gomega
2
3Your contributions to Gomega are essential for its long-term maintenance and improvement. To make a contribution:
4
5- 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!
6- Ensure adequate test coverage:
7 - Make sure to add appropriate unit tests
8 - Please run all tests locally (`ginkgo -r -p`) and make sure they go green before submitting the PR
9 - Please run following linter locally `go vet ./...` and make sure output does not contain any warnings
10- 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.
11
12If you're a committer, check out RELEASING.md to learn how to cut a release.
13
14Thanks for supporting Gomega!
View as plain text