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
Tobias Schmidt ee7f81b665 Add note that pbcopy is only available in OSX 
Change-Id: I4eda3a5a9117b5021fbc6e3625afa01100c39fa6
2013-12-03 18:06:04 +07:00

1.8 KiB
Raw Blame History

Contributing

Prometheus uses Gerrit to manage reviews of pull-requests, and then Gerrit replicates its master branch to GitHub. In order to contribute to Prometheus, you must use Gerrit.

Setup

  1. Sign in at http://review.prometheus.io/

  2. Set a username and upload an SSH pubkey for git ssh access.

    On OSX you can use cat ~/.ssh/id_rsa.pub | pbcopy to copy your public key to your clipboard so you can paste it.

  3. Clone the repo: git clone http://review.prometheus.io/prometheus

  4. Add your user-specific remote that you will push your changes to: git remote add <your-remote-name> ssh://<username>@review.prometheus.io:29418/prometheus

  5. Add Change-Id commit hook: curl -o .git/hooks/commit-msg http://review.prometheus.io/tools/hooks/commit-msg

  6. Make the file executable: chmod u+x .git/hooks/commit-msg

  7. Commit any local changes to git, then:

  8. git push <your-remote-name> HEAD:refs/for/master

  9. Assign reviewer for change at http://review.prometheus.io/

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.

    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.

  3. Welcome aboard!