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

CONTRIBUTING.md

Browse Source
This commit is contained in:
Tim Green
2015-01-18 23:01:31 +00:00
parent 3b04f63081
commit 704d07fcc6
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -1,7 +1,7 @@
# Contributing # Contributing
1. Fork the repository. 1. Fork the repository.
2. Add your section - make sure you follow the [styling](#styling) guide. 2. Add your section - make sure you follow the styling guide below.
3. Commit changes. 3. Commit changes.
4. Push your commit. 4. Push your commit.
5. Create a Pull Request. 5. Create a Pull Request.
@@ -12,6 +12,6 @@
- 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.
- 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. - At the end of your section, add a `Read more about...` link. This should directly link to [Git's](http://git-scm.com/docs), [GitHub's](https://help.github.com), or the relevant documentation.
- If your contribution is a translation, add a (relative) link to the README above the [Table of Contents](README.md#table-of-contents). - If your contribution is a translation, add a (relative) link to the README above the [Table of Contents](README.md#table-of-contents).