1
0
mirror of https://github.com/tiimgreen/github-cheat-sheet.git synced 2025-08-15 04:13:58 +02:00

Improve contributing guide

This commit is contained in:
Rafal Chmiel
2014-04-14 15:34:37 +01:00
parent b32ba31242
commit 9bab1c407d

View File

@@ -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.