add CONTRIBUTING.md

This commit is contained in:
Rajika Imal 2016-08-06 18:48:18 +05:30 committed by GitHub
parent 4e8fd1d803
commit 5f17cd91b9

19
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,19 @@
# Contributing Guidelines
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: [package](link) - Description.
- Additions should be added to the bottom of the relevant category.
- New categories, or improvements to the existing categorization are welcome.
- Link to the GitHub repo, not npmjs.com.
- Keep descriptions short and simple, but descriptive.
- Don't mention express.js in the description as it's implied.
- Start the description with a capital and end with a full stop/period.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request should have a useful title and include a link to the package and why it should be included.
Thank you for your suggestion!