From af5114d81e4d090fd6edae9b7e7e3d57cf9fa9e3 Mon Sep 17 00:00:00 2001 From: Stuart Nelson Date: Wed, 23 Oct 2013 10:11:43 -0400 Subject: [PATCH 1/4] add contributing.md Change-Id: Ia3284a90dfbbaaf655facd885a8ef13858bdb2c9 --- documentation/CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 documentation/CONTRIBUTING.md diff --git a/documentation/CONTRIBUTING.md b/documentation/CONTRIBUTING.md new file mode 100644 index 0000000000..d27443a04d --- /dev/null +++ b/documentation/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# 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. `cat + ~/.ssh/id_rsa.pub | pbcopy` will 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 ssh://@review.prometheus.io:29418/prometheus` +4. 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 HEAD:refs/for/master` +9. Assign reviewer for change at http://review.prometheus.io/ + +That's all! From dd2b5e0e1c3c6d9bab667319cab82b6c19995d01 Mon Sep 17 00:00:00 2001 From: Stuart Nelson Date: Wed, 23 Oct 2013 10:16:25 -0400 Subject: [PATCH 2/4] change double quotes to backticks for md awesomeness Change-Id: Ife68c9c67d36ffec24927176ab519f7cb08976a8 --- documentation/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/CONTRIBUTING.md b/documentation/CONTRIBUTING.md index d27443a04d..cde3d777a7 100644 --- a/documentation/CONTRIBUTING.md +++ b/documentation/CONTRIBUTING.md @@ -13,7 +13,7 @@ Prometheus, you must use Gerrit. 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 ssh://@review.prometheus.io:29418/prometheus` -4. Add Change-Id commit hook: "curl -o .git/hooks/commit-msg http://review.prometheus.io/tools/hooks/commit-msg" +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 HEAD:refs/for/master` From 28b055554f67c49dfc97adc713ce8039a11e8613 Mon Sep 17 00:00:00 2001 From: Stuart Nelson Date: Wed, 23 Oct 2013 16:21:35 -0400 Subject: [PATCH 3/4] moved CONTRIBUTING.md to top of repo; link to CONTRIBUTING.md in README.md Change-Id: Ibe1def5c0c5e1e7f6eb0da344badc53d18f2ecb3 --- .../CONTRIBUTING.md => CONTRIBUTING.md | 20 ++++++++++++++++++- README.md | 18 +---------------- 2 files changed, 20 insertions(+), 18 deletions(-) rename documentation/CONTRIBUTING.md => CONTRIBUTING.md (54%) diff --git a/documentation/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 54% rename from documentation/CONTRIBUTING.md rename to CONTRIBUTING.md index cde3d777a7..5fd371b560 100644 --- a/documentation/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,4 +19,22 @@ Prometheus, you must use Gerrit. 8. `git push 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! diff --git a/README.md b/README.md index a8e3840a70..a6d418ba4e 100644 --- a/README.md +++ b/README.md @@ -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 From 1e357cf859846d55e1203087620d2a38397ba6f4 Mon Sep 17 00:00:00 2001 From: Stuart Nelson Date: Wed, 23 Oct 2013 16:26:39 -0400 Subject: [PATCH 4/4] fix link to CONTRIBUTING.md in README.md Change-Id: I53a24c061d0610a9c4b3c515c7d5ba7c04ae9f54 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a6d418ba4e..8429083059 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ To run the server with race detection: ## Contributing -Refer to (CONTRIBUTING.md) +Refer to [CONTRIBUTING.md](CONTRIBUTING.md) ## License