mirror of
https://github.com/rancher/plugins.git
synced 2025-09-25 15:53:20 +00:00
23c2134110
This commit updates ginkgo to v2. Note that because ginkgo/v2 requires go1.18, it was updated as well. Signed-off-by: liornoy <lnoy@redhat.com> Co-authored-by: Sascha Grunert <sgrunert@redhat.com>
13 lines
851 B
Markdown
13 lines
851 B
Markdown
# 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.
|
|
- Make sure all the tests succeed via `ginkgo -r -p`
|
|
- Vet your changes via `go vet ./...`
|
|
- 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.
|
|
|
|
Thanks for supporting Ginkgo! |