Your contributions to Ginkgo are essential for its long-term maintenance and improvement.
- 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!
- Ensure adequate test coverage:
- When adding to the Ginkgo library, add unit and/or integration tests (under the
integrationfolder). - When adding to the Ginkgo CLI, note that there are very few unit tests. Please add an integration test.
- When adding to the Ginkgo library, add unit and/or integration tests (under the
- Make sure all the tests succeed via
ginkgo -r -p - Vet your changes via
go vet ./... - Update the documentation. Ginkgo uses
godoccomments and documentation indocs/index.md. You can runbundle exec jekyll servein thedocsdirectory to preview your changes.
Thanks for supporting Ginkgo!