mirror of
https://github.com/tiimgreen/github-cheat-sheet.git
synced 2025-02-23 21:34:40 +01:00
32 lines
687 B
Markdown
32 lines
687 B
Markdown
# Contributing
|
|
|
|
1. Fork it (http://github.com/tiimgreen/github-cheat-sheet/fork)
|
|
2. Commit your changes
|
|
3. Push changes
|
|
4. Create new Pull Request
|
|
|
|
## Styling
|
|
|
|
- Use h2 for header:
|
|
```
|
|
## New Feature
|
|
```
|
|
- Add new feature in Contents Menu in correct position
|
|
- For internal links e.g. Contents use relative links:
|
|
```
|
|
- [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
|