Skip to content

Commit 4636f69

Browse files
authored
Create CONTRIBUTING.md
1 parent f743d31 commit 4636f69

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contribution Guidelines
2+
3+
Please ensure your pull request adheres to the following guidelines:
4+
5+
- Search previous suggestions before making a new one, as yours may be a duplicate.
6+
- Make sure your contribution is useful before submitting.
7+
- Make an individual pull request for each suggestion.
8+
- Use the following format: `[name](link) - Address.`
9+
- Additions should be added in alphabetical order of the relevant category.
10+
- New categories, or improvements to the existing categorization are welcome.
11+
- Keep descriptions short and simple, but descriptive.
12+
- Start the description with a capital and end with a full stop/period.
13+
- Check your spelling and grammar.
14+
- Make sure your text editor is set to remove trailing whitespace.
15+
- The pull request should have a useful title and include a link to the package and why it should be included.
16+
17+
---
18+
19+
**Working on your first Pull Request?** You can learn how from this free series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
20+
21+
Thank you for your suggestion!

0 commit comments

Comments
 (0)