Skip to content

Commit 4106146

Browse files
committed
Create CONTRIBUTING.md
1 parent d4af005 commit 4106146

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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+
- Suggested packages should be tested and documented.
7+
- Make an individual pull request for each suggestion.
8+
- Use the following format: `[package](link) - Description.`
9+
- Additions should be added to the bottom of the relevant category.
10+
- New categories, or improvements to the existing categorization are welcome.
11+
- Link to the GitHub repo, not official website, npm, pypi.
12+
- Keep descriptions short and simple, but descriptive.
13+
- Start the description with a capital and end with a full stop/period.
14+
- Check your spelling and grammar.
15+
- Make sure your text editor is set to remove trailing whitespace.
16+
- The pull request should have a useful title and include a link to the package and why it should be included.
17+
18+
Thank you for your suggestions!
19+
20+
### Updating your PR
21+
22+
A lot of times, making a PR adhere to the standards above can be difficult.
23+
If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it.
24+
If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it.

0 commit comments

Comments
 (0)