You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-3
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,10 @@ Your contributions to Ginkgo are essential for its long-term maintenance and imp
6
6
- Ensure adequate test coverage:
7
7
- When adding to the Ginkgo library, add unit and/or integration tests (under the `integration` folder).
8
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.
9
+
- Run `make` or:
10
+
- Install ginkgo locally via `go install ./...`
11
+
- Make sure all the tests succeed via `ginkgo -r -p`
12
+
- Vet your changes via `go vet ./...`
13
+
- Update the documentation. Ginkgo uses `godoc` comments and documentation in `docs/index.md`. You can run `bundle && bundle exec jekyll serve` in the `docs` directory to preview your changes.
0 commit comments