From 9bab1c407d2a39261efc9ecb88edc6091b5c488a Mon Sep 17 00:00:00 2001 From: Rafal Chmiel Date: Mon, 14 Apr 2014 15:34:37 +0100 Subject: [PATCH] Improve contributing guide --- CONTRIBUTING.md | 37 +++++++++++-------------------------- 1 file changed, 11 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62be378..1d049a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,31 +1,16 @@ # Contributing -1. Fork it (http://github.com/tiimgreen/github-cheat-sheet/fork) -2. Commit your changes -3. Push changes -4. Create new Pull Request +1. Fork the repository. +2. Add your section - make sure you follow the [styling](#styling) guide. +3. Commit changes. +4. Push your commit. +5. Create a Pull Request. ## Styling -- Use h2 for header: -``` -## New Feature -``` -- Add new feature in Contents Menu in correct position -- For internal links e.g. Contents use relative links: -``` -- [Ignore Whitespace](#ignore-whitespace) -``` -Not: -``` -- [Ignore Whitespace](https://github.com/tiimgreen/github-cheat-sheet#ignore-whitespace) -``` -- Add examples wherever possible -- Use `bash` styling for all git commands: -```bash -$ git commit -m "Message" -``` - ```bash - $ git commit -m "Message" - ``` -- Add links to Git docs or GitHub docs wherever possible +- Use `##` headers for your sections. +- Also use `##` for categories (these should group together relevant sections) and `###` for subcategories. +- Add a link to your section/category to the contents section (use relative links). +- Make sure to include examples wherever possible (preferably GIFs). +- For command-line examples, wrap your commands in a `bash` code block. Ask [@rafalchmiel](https://github.com/rafalchmiel) or [@tiimgreen](https://github.com/tiimgreen) to take a screenshot (so that it is consistent with the rest) of the output if it has color, etc. +- At the end of your section, add a `Read more about...` link. This should directly link to [Git's](http://git-scm.com/docs) or [GitHub's](https://help.github.com/) documentation.