From 8e120d181a4d8f2368c9da03376f3cd1cee478f8 Mon Sep 17 00:00:00 2001 From: Francois Zaninotto Date: Tue, 21 Jul 2015 10:52:56 +0200 Subject: [PATCH] Add contribution guidelines Closes #15 --- contributing.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..bddf4bc --- /dev/null +++ b/contributing.md @@ -0,0 +1,27 @@ +# Contribution Guidelines + +Please ensure your pull request adheres to the following guidelines: + +- Read [the awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies. +- Search previous suggestions before making a new one, as yours may be a duplicate. +- Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description. +- A link back to this list from yours, so users can discover more lists, would be appreciated. +- Make an individual pull request for each suggestion. +- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html). +- Use the following format: `[List Name](link)` +- If you have a comment about the link, add it after a dash, start it with a capital letter, and end it with a full stop. Avoid starting your comment with an article like "A", "The". +- Link additions should be added to the bottom of the relevant category. +- New categories or improvements to the existing categorization are welcome. +- Check your spelling and grammar. +- Make sure your text editor is set to remove trailing whitespace. +- The pull request and commit should have a useful title. + +Link format: + +``` +[Awesome resource name](resource link) - Performant REST client library by the famous John Doe. + ^ ^ ^ + dash capital letter, no article Full stop +``` + +Thank you for your suggestions!