mirror of
https://github.com/tiimgreen/github-cheat-sheet.git
synced 2025-02-23 21:34:40 +01:00
939 B
939 B
Contributing
- Fork the repository.
- Add your section - make sure you follow the styling guide.
- Commit changes.
- Push your commit.
- Create a Pull Request.
Styling
- 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 or @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 or GitHub's documentation.