From 7ca7e30c4b4143abb0b080f3ce5f67961cc8fad4 Mon Sep 17 00:00:00 2001 From: Tim Green Date: Sun, 13 Apr 2014 12:26:24 +0100 Subject: [PATCH] Add CONTRIBUTING.md, close #5 --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3009e4e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing + +1. Fork it (http://github.com/tiimgreen/github-cheat-sheet/fork) +2. Commit your changes +3. Push changes +4. Create new Pull Request + +## Styling + +- Use h2 for header: +```markdown +## New Feature +``` +- Add examples wherever possible +- Use `bash` styling for all git commands: + ```bash + $ git commit -m "Message" + ``` +- Add links to Git docs or GitHub docs wherever possible