Skip to content

Commit

Permalink
moved CONTRIBUTING.md to top of repo; link to CONTRIBUTING.md in READ…
Browse files Browse the repository at this point in the history
…ME.md

Change-Id: Ibe1def5c0c5e1e7f6eb0da344badc53d18f2ecb3
  • Loading branch information
stuartnelson3 committed Oct 23, 2013
1 parent dd2b5e0 commit 28b0555
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 18 deletions.
20 changes: 19 additions & 1 deletion documentation/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,22 @@ Prometheus, you must use Gerrit.
8. `git push <your-remote-name> HEAD:refs/for/master`
9. Assign reviewer for change at http://review.prometheus.io/

That's all!
## Getting Started

1. Reach out via our [mailing list](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers) and ask us what
the current priorities are. We can find a good isolated starter project for
you.

2. Keeping code hygiene is important. We thusly have a practical preference
for the following:

1. Run ``make format`` to ensure the correctness of the Go code's layout.

2. Run ``make advice`` to find facial errors with a static analyzer.

3. Try to capture your changes in some form of a test. Go makes it easy to
write [Table Driven Tests](https://code.google.com/p/go-wiki/wiki/TableDrivenTests).
There is no mandate to use this said scaffolding mechanism, but it _can_
make your life easier in the right circumstances.

3. Welcome aboard!
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,23 +100,7 @@ To run the server with race detection:

## Contributing

1. To start, reach out via our mailing list (mentioned above) and ask us what
the current priorities are. We can find a good isolated starter project for
you.

2. Keeping code hygiene is important. We thusly have a practical preference
for the following:

1. Run ``make format`` to ensure the correctness of the Go code's layout.

2. Run ``make advice`` to find facial errors with a static analyzer.

3. Try to capture your changes in some form of a test. Go makes it easy to
write [Table Driven Tests](https://code.google.com/p/go-wiki/wiki/TableDrivenTests).
There is no mandate to use this said scaffolding mechanism, but it _can_
make your life easier in the right circumstances.

3. Welcome aboard!
Refer to (CONTRIBUTING.md)

## License

Expand Down

0 comments on commit 28b0555

Please sign in to comment.