From 28b055554f67c49dfc97adc713ce8039a11e8613 Mon Sep 17 00:00:00 2001 From: Stuart Nelson Date: Wed, 23 Oct 2013 16:21:35 -0400 Subject: [PATCH] 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