github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-02 00:07:50 +00:00
Code Issues Projects Releases Wiki Activity
master
kubernetes/vendor/github.com/onsi/ginkgo/v2/CONTRIBUTING.md
Patrick Ohly 1e4edaf2fe e2e: bump ginkgo to v2.2.0 
The new release adds support for intermediate progress reports.
2022-09-18 10:10:07 +02:00

851 B
Raw Permalink Blame History

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!