mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-12-24 21:24:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md.

Browse source
This commit is contained in:
Bjoern Rabenstein 2015-01-22 15:02:18 +01:00
parent edc91cbabb
commit 87d19b94fc
1 changed files with 13 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
CONTRIBUTING.md
View file

@ -1,30 +1,18 @@
# Contributing
Prometheus uses GitHub to manage reviews of pull-requests.
Prometheus uses GitHub to manage reviews of pull requests.
## Getting Started
* If you have a trivial fix or improvement, go ahead and create a pull
request, addressing (with `@...`) one or more of the maintainers
(see [AUTHORS.md](AUTHORS.md)) in the description of the pull request.
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.
* If you plan to do something more involved, first discuss your ideas
on our [mailing list](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
This will avoid unnecessary work and surely give you and us a good deal
of inspiration.
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. In addition, consider running
[`golint`](https://github.com/golang/lint).
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.
4. Relevant style guidelines are the [Go Code Review
Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments)
and the _Formatting and style_ section of Peter Bourgon's [Go:
Best Practices for Production
Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style).
3. Welcome aboard!
* Relevant coding style guidelines are the [Go Code Review
Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments)
and the _Formatting and style_ section of Peter Bourgon's [Go: Best
Practices for Production
Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style).