Skip to content

Commit a9009b0

Browse files
committed
Improve instructions for contributing (closes #9)
1 parent 506815f commit a9009b0

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

CONTRIBUTING.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,17 @@ contribution. See the [DCO](DCO) file for details.
1515

1616
## Getting Started
1717

18-
- Fork the repository on GitHub
19-
- Read the [README](README.md) for build and test instructions
20-
- Play with the project, submit bugs, submit patches!
18+
You'll need Go 1.7 or newer installed.
19+
20+
1. [Fork this repo](https://github.com/sourcegraph/checkup). This makes a copy of the code you can write to.
21+
2. If you don't already have this repo (sourcegraph/checkup.git) repo on your computer, get it with `go get github.com/sourcegraph/checkup/cmd/checkup`.
22+
3. Tell git that it can push the sourcegraph/checkup.git repo to your fork by adding a remote: `git remote add myfork https://github.com/you/checkup.git`
23+
4. Make your changes in the sourcegraph/checkup.git repo on your computer.
24+
5. Push your changes to your fork: `git push myfork`
25+
6. [Create a pull request](https://github.com/sourcegraph/checkup/pull/new/master) to merge your changes into sourcegraph/checkup @ master. (Click "compare across forks" and change the head fork.)
26+
27+
You can test your changes with `go run main.go` or `go build` if you want a binary plopped on disk. Use `go test -race ./...` from the root of the repo to run tests and make sure they pass!
28+
2129

2230
## Contribution Flow
2331

0 commit comments

Comments
 (0)