mirror of
https://github.com/prometheus/prometheus.git
synced 2025-01-12 06:17:27 -08:00
Link to relevant style guidelines.
Change-Id: Iac9777a62a11cb8e5c13efe5229a85e82c5039cb
This commit is contained in:
parent
4df5c7ab18
commit
da28f8dd13
|
@ -31,11 +31,19 @@ Prometheus, you must use Gerrit.
|
||||||
|
|
||||||
1. Run ``make format`` to ensure the correctness of the Go code's layout.
|
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.
|
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
|
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).
|
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_
|
There is no mandate to use this said scaffolding mechanism, but it _can_
|
||||||
make your life easier in the right circumstances.
|
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!
|
3. Welcome aboard!
|
||||||
|
|
Loading…
Reference in a new issue