mirror of
https://github.com/akullpp/awesome-java.git
synced 2024-11-20 11:28:01 -05:00
Update CONTRIBUTING.md
Made some fixes, condensed some language.
This commit is contained in:
parent
f3c5d5a0b8
commit
7cf9366107
1 changed files with 8 additions and 9 deletions
|
@ -1,19 +1,18 @@
|
|||
# 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. Awesome Java 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
|
||||
|
||||
(c) absolutely unique in its approach and function
|
||||
(c) absolutely unique in its approach and function; and/or
|
||||
|
||||
(d) a niche product that fills a gap
|
||||
(d) a niche product that fills a gap.
|
||||
|
||||
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.
|
||||
Self-promotion is frowned upon and viewed critically, but your suggestion will of course be approved if the criteria match.
|
||||
|
||||
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:
|
||||
|
||||
|
@ -21,8 +20,8 @@ Furthermore, please ensure your pull request follows the following guidelines:
|
|||
* Please make an individual pull request for each suggestion.
|
||||
* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
|
||||
* Entries should be sorted in ascending alphabetical order, i.e. a to z.
|
||||
* New categories, or improvements to the existing categorization are welcome.
|
||||
* Keep descriptions short, simple and unbiased.
|
||||
* New categories or improvements to the existing categorization are welcome.
|
||||
* Keep descriptions short, simple and unbiased.
|
||||
* End all descriptions with a full stop/period.
|
||||
* Check your spelling and grammar.
|
||||
* Make sure your text editor is set to remove trailing whitespace.
|
||||
|
|
Loading…
Reference in a new issue