Skip to content

Commit

Permalink
consolidate and streamline contribution docs (#494)
Browse files Browse the repository at this point in the history
  • Loading branch information
grosser authored and Andrea Nodari committed Jul 13, 2018
1 parent 39febac commit d848015
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 22 deletions.
32 changes: 26 additions & 6 deletions CONTRIBUTING.md
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 🎉
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,4 @@ Ginkgo is MIT-Licensed

## Contributing

Since Ginkgo tests also internal packages, when you fork, you'll have to replace imports with your repository.<br />
Use `before_pr.sh` for that<br />
After you finished your changes and before you push your pull request, use `after_pr.sh` to revert those changes
See [CONTRIBUTING.md](CONTRIBUTING.md)
13 changes: 0 additions & 13 deletions before_pr.sh

This file was deleted.

0 comments on commit d848015

Please sign in to comment.