1# Contributing to Ginkgo
 2
 3Your contributions to Ginkgo are essential for its long-term maintenance and improvement.
 4
 5- 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!
 6- Ensure adequate test coverage:
 7    - When adding to the Ginkgo library, add unit and/or integration tests (under the `integration` folder).
 8    - When adding to the Ginkgo CLI, note that there are very few unit tests.  Please add an integration test.
 9- Update the documentation. Ginko uses `godoc` comments and documentation on the `gh-pages` branch.
10  If relevant, please submit a docs PR to that branch alongside your code PR.
11
12Thanks for supporting Ginkgo!
13
14## Setup
15
16Fork the repo, then:
17
18```
19go get github.com/onsi/ginkgo
20go get github.com/onsi/gomega/...
21cd $GOPATH/src/github.com/onsi/ginkgo
22git remote add fork git@github.com:<NAME>/ginkgo.git
23
24ginkgo -r -p   # ensure tests are green
25go vet ./...   # ensure linter is happy
26```
27
28## Making the PR
29 - go to a new branch `git checkout -b my-feature`
30 - make your changes
31 - run tests and linter again (see above)
32 - `git push fork`
33 - open PR 🎉