1
0
mirror of https://github.com/tiimgreen/github-cheat-sheet.git synced 2025-02-23 13:23:21 +01:00
github-cheat-sheet/CONTRIBUTING.md

17 lines
942 B
Markdown
Raw Normal View History

2014-04-13 12:26:24 +01:00
# Contributing
2014-04-14 15:34:37 +01:00
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.
2014-04-13 12:26:24 +01:00
## Styling
- Use `###` headers for your sections.
- Also use `###` for categories (these should group together relevant sections) and `####` for subcategories.
2014-04-14 15:34:37 +01:00
- 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.