gaspersic/awesome-java
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update contribution rules

Browse Source
This commit is contained in:
Andreas Kull
2017-05-02 13:18:28 +02:00
parent f3c5d5a0b8
commit d4406a3e1e
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -10,11 +10,16 @@ Unfortunately, not every library/tool/framework can be considered. The aim of th
(d) a niche product that fills a gap (d) a niche product that fills a gap
There are two required criteria for a pull request:
1. If an entry has a similar scope as other entries in the same category, the description must state the unique features that distinguishes it from the other entries.
2. If an entry does not met conditions *(a)* to *(d)* there has to be an explanation either in the description or the pull request why it should be added to the list.
Self-promotion is frowned upon and will be reviewed critically but the suggestion will of course be approved if they criteria match. Self-promotion is frowned upon and will be reviewed critically but the suggestion will of course be approved if they criteria match.
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. 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 guidelines: Furthermore, please ensure your pull request follows the following guidelines:
* Please search previous suggestions before making a new one, as yours may be a duplicate. * Please search previous suggestions before making a new one, as yours may be a duplicate.
@ -22,7 +27,7 @@ Furthermore, please ensure your pull request follows the following guidelines:
* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION. * Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
* Entries should be sorted in ascending alphabetical order, i.e. a to z. * Entries should be sorted in ascending alphabetical order, i.e. a to z.
* New categories, or improvements to the existing categorization are welcome. * New categories, or improvements to the existing categorization are welcome.
* Keep descriptions short, simple and unbiased. * Keep descriptions short, simple and unbiased.
* End all descriptions with a full stop/period. * End all descriptions with a full stop/period.
* Check your spelling and grammar. * Check your spelling and grammar.
* Make sure your text editor is set to remove trailing whitespace. * Make sure your text editor is set to remove trailing whitespace.