mirror of
https://github.com/tiimgreen/github-cheat-sheet.git
synced 2025-08-14 11:53:58 +02:00
Improve contributing guide
This commit is contained in:
@@ -1,31 +1,16 @@
|
|||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
1. Fork it (http://github.com/tiimgreen/github-cheat-sheet/fork)
|
1. Fork the repository.
|
||||||
2. Commit your changes
|
2. Add your section - make sure you follow the [styling](#styling) guide.
|
||||||
3. Push changes
|
3. Commit changes.
|
||||||
4. Create new Pull Request
|
4. Push your commit.
|
||||||
|
5. Create a Pull Request.
|
||||||
|
|
||||||
## Styling
|
## Styling
|
||||||
|
|
||||||
- Use h2 for header:
|
- Use `##` headers for your sections.
|
||||||
```
|
- Also use `##` for categories (these should group together relevant sections) and `###` for subcategories.
|
||||||
## New Feature
|
- Add a link to your section/category to the contents section (use relative links).
|
||||||
```
|
- Make sure to include examples wherever possible (preferably GIFs).
|
||||||
- Add new feature in Contents Menu in correct position
|
- 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 internal links e.g. Contents use relative links:
|
- 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.
|
||||||
```
|
|
||||||
- [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
|
|
||||||
|
Reference in New Issue
Block a user