Merge pull request #508 from LappleApple/patch-1

Update CONTRIBUTING.md
This commit is contained in:
Andreas Kull
2017-05-24 00:19:09 +02:00
committed by GitHub

View File

@ -1,8 +1,8 @@
# Contribution Guidelines # Contribution Guidelines
Unfortunately, not every library/tool/framework can be considered. The aim of the list is to provide a concise list of noteworthy modern software. This means that suggested software is either Unfortunately, not every library/tool/framework can be considered. This list aims to provide a concise list of noteworthy modern software. This means that suggested software is:
(a) widely recommended regardless of personal opinion (a) widely recommended, regardless of personal opinion
(b) highly discussed in the community due to its innovative nature (b) highly discussed in the community due to its innovative nature
@ -16,9 +16,9 @@ There are two required criteria for a pull request:
2. If an entry does not meet 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. 2. If an entry does not meet 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 viewed critically, but your suggestion will of course be approved if the 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 your entry isn't accepted, please check the [Issues](https://github.com/akullpp/awesome-java/issues) for items marked with the "question" tag to see if it had been previously discussed. If nothing comes up, feel free to create a new issue, adding the "question" tag.
Furthermore, please ensure your pull request follows the following guidelines: Furthermore, please ensure your pull request follows the following guidelines:
@ -26,7 +26,7 @@ Furthermore, please ensure your pull request follows the following guidelines:
* Please make an individual pull request for each suggestion. * Please make an individual pull request for each suggestion.
* 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.