lists/github-cheat-sheet
1
0
Fork 0
mirror of https://github.com/tiimgreen/github-cheat-sheet.git synced 2025-08-17 21:21:17 +02:00
Code Issues Releases Wiki Activity

Update contributing guide to fit new organization

Browse Source
This commit is contained in:
Rafal Chmiel
2014-04-14 19:51:06 +01:00
parent d94e3c69d6
commit e4b415249a
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@@ -8,8 +8,8 @@
## Styling ## Styling
- Use `##` headers for your sections. - Use `###` headers for your sections.
- Also use `##` for categories (these should group together relevant sections) and `###` for subcategories. - 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). - Add a link to your section/category to the contents section (use relative links).
- Make sure to include examples wherever possible (preferably GIFs). - 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. - 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.