Skip to content

Commit

Permalink
add a not of the format
Browse files Browse the repository at this point in the history
  • Loading branch information
stevemao authored Jul 5, 2018
1 parent 02e84ce commit 914c52d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Suggested packages should be tested and documented.
- Make an individual pull request for each suggestion.
- Use the following format:
- Use the following format:

```md
## [package](link)
Expand All @@ -18,6 +18,12 @@ Please ensure your pull request adheres to the following guidelines:
```
```

**NOTE:** You *could* include a screenshot, a short description or whatever you like if:
1. It simply makes it a lot easier for the readers to understand.
1. It is hard to reproduce the command (EG: must follow sequences).
1. The output of the command is not self-explanatory of what it's doing.
1. Any other good reasons.

- Additions should be added to the bottom of the relevant category.
- New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive.
Expand Down

0 comments on commit 914c52d

Please sign in to comment.