RepoMirrors
/
prometheus
mirror of https://github.com/prometheus/prometheus
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

moved CONTRIBUTING.md to top of repo; link to CONTRIBUTING.md in README.md 

Change-Id: Ibe1def5c0c5e1e7f6eb0da344badc53d18f2ecb3
This commit is contained in:
Stuart Nelson 2013-10-23 16:21:35 -04:00
parent dd2b5e0e1c
commit 28b055554f
2 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/CONTRIBUTING.md → CONTRIBUTING.md
View File

@ -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
README.md
View File

@ -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