mirror of
https://github.com/NVIDIA/nvidia-container-toolkit
synced 2025-02-04 20:15:45 +00:00
bf9d618ff2
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com> Signed-off-by: Evan Lezar <elezar@nvidia.com>
933 B
933 B
Contributing to Ginkgo
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
integration
folder). - 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
- Run
make
or:- Install ginkgo locally via
go install ./...
- Make sure all the tests succeed via
ginkgo -r -p
- Vet your changes via
go vet ./...
- Install ginkgo locally via
- Update the documentation. Ginkgo uses
godoc
comments and documentation indocs/index.md
. You can runbundle && bundle exec jekyll serve
in thedocs
directory to preview your changes.
Thanks for supporting Ginkgo!