1# Contributing to Ginkgo
2
3Your contributions to Ginkgo are essential for its long-term maintenance and improvement.
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 - When adding to the Ginkgo library, add unit and/or integration tests (under the `integration` folder).
8 - When adding to the Ginkgo CLI, note that there are very few unit tests. Please add an integration test.
9- Make sure all the tests succeed via `ginkgo -r -p`
10- Vet your changes via `go vet ./...`
11- Update the documentation. Ginkgo uses `godoc` comments and documentation in `docs/index.md`. You can run `bundle exec jekyll serve` in the `docs` directory to preview your changes.
12
13Thanks for supporting Ginkgo!View as plain text