Permalink
Browse files

Merge pull request #3 from iennae/update_docs

Fixes Issue:2 -- Update docs
  • Loading branch information...
2 parents b04a594 + 9c7d1c9 commit c8c2aff3d95e2c1e000b6e6407a341872be59f32 @azet azet committed Jul 21, 2014
Showing with 48 additions and 0 deletions.
  1. +48 −0 CONTRIBUTING.md
View
@@ -0,0 +1,48 @@
+# Contributing to Metrics Catalog
+
+## Create an Issue
+
+[Create an issue](https://github.com/monitoringsucks/metrics-catalog/issues).
+
+## Fork the Repo
+
+[Fork the repo](https://github.com/monitoringsucks/metrics-catalog/fork).
+
+```
+$ git clone https://github.com/<username>/metrics-catalog.git
+$ cd metrics-catalog
+$ git remote add upstream https://github.com/monitoringsucks/metrics-catalog.git
+```
+
+## Create a Local Feature Branch
+
+Create a feature branch and start adding updates.
+
+```
+
+$ git checkout -b my-feature-branch
+
+```
+
+## Commit
+
+Write a good commit message. A commit message should describe what changed and why.
+
+
+1. If this commit fixes/closes an issue prefix the commit header message likes this: "Fixes #ISSUENUMBER".
+2. Blank line.
+3. More details with regards to the commit.
+
+## Push
+
+```
+
+$ git push origin my-feature-branch
+
+```
+
+## Create a Pull Request
+
+Select your feature branch from https://github.com/monitoringsucks/ and click the 'Pull Request' button. Fill out the form.
+
+Thank you.

0 comments on commit c8c2aff

Please sign in to comment.