mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-11-10 07:34:04 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
prometheus/CONTRIBUTING.md
Brian Brazil a7eb9f6fb0 Update contributing guide to remove gerrit. 
The contributors list is outdated, update. Looks like we're sorting by first name.
2015-01-02 10:14:05 +00:00

1.3 KiB
Raw Blame History

Contributing

Prometheus uses GitHub to manage reviews of pull-requests.

Getting Started

  1. Reach out via our mailing list 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. In addition, consider running golint.

    3. Try to capture your changes in some form of a test. Go makes it easy to write Table Driven Tests. 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 and the Formatting and style section of Peter Bourgon's Go: Best Practices for Production Environments.

  3. Welcome aboard!