From 5f17cd91b92dabd98cab571fb0ea3e6d38fd3718 Mon Sep 17 00:00:00 2001 From: Rajika Imal Date: Sat, 6 Aug 2016 18:48:18 +0530 Subject: [PATCH] add CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b9e81dc --- /dev/null +++ b/CONTRIBUTING.md @@ -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!