-
-
Notifications
You must be signed in to change notification settings - Fork 650
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
consolidate and streamline contribution docs (#494)
- Loading branch information
Showing
3 changed files
with
27 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,33 @@ | ||
# Contributing to Ginkgo | ||
|
||
Your contributions to Ginkgo are essential for its long-term maintenance and improvement. To make a contribution: | ||
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: | ||
- If you're adding functionality to the Ginkgo library, make sure to add appropriate unit and/or integration tests (under the `integration` folder). | ||
- If you're adding functionality to the Ginkgo CLI note that there are very few unit tests. Please add an integration test. | ||
- Please run all tests locally (`ginkgo -r -p`) and make sure they go green before submitting the PR | ||
- Please run following linter locally `go vet ./...` and make sure output does not contain any warnings | ||
- Update the documentation. In addition to standard `godoc` comments Ginkgo has extensive documentation on the `gh-pages` branch. If relevant, please submit a docs PR to that branch alongside your code PR. | ||
- 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. | ||
- Update the documentation. Ginko uses `godoc` comments and documentation on the `gh-pages` branch. | ||
If relevant, please submit a docs PR to that branch alongside your code PR. | ||
|
||
Thanks for supporting Ginkgo! | ||
|
||
## Setup | ||
|
||
Fork the repo, then: | ||
|
||
``` | ||
go get https://github.com/onsi/ginkgo | ||
go get github.com/onsi/gomega/... | ||
cd $GOPATH/onsi/ginkgo | ||
git remote add fork git@github.com:<NAME>/ginkgo.git | ||
ginkgo -r -p # ensure tests are green | ||
go vet ./... # ensure linter is happy | ||
``` | ||
|
||
## Making the PR | ||
- go to a new branch `git checkout -b my-feature` | ||
- make your changes | ||
- run tests and linter again (see above) | ||
- `git push fork` | ||
- open PR 🎉 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.