From c0e0afca649f8067f9de99642b5add2337d0ee03 Mon Sep 17 00:00:00 2001 From: akullpp Date: Fri, 11 Jul 2014 21:47:16 +0200 Subject: [PATCH] Create CONTRIBUTING.md Init --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..babea12 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contribution Guidelines + +Unfortunately, not every library/tool/framework can be considered. The aim of the list is to provide a concise list of noteworthy software. This means that suggested software is either + +(a) widely used so that its existence alone is a reason to know it regardless of personal opinion +(b) highly discussed in the community due to its innovative nature +(b) absolutely unique in its approach and function + +If a certain entry does not get accepted, you should first look if there has been a discussion before. These discussions are in the issue section and normally marked with the question tag. If there hasn't been such a topic, you are free to create a new issue tagged as question. + + +Furthermore, please ensure your pull request follows the following guidlines: + +* Please search previous suggestions before making a new one, as yours may be a duplicate. +* Please make an individual pull request for each suggestion. +* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION. +* Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar. +* New categories, or improvements to the existing categorisation are welcome. +* Keep descriptions short and simple. +* End all descriptions with a full stop/period. +* Check your spelling and grammar. +* Make sure your text editor is set to remove trailing whitespace. + +Thank you for your suggestions!