1
0
Fork 0
mirror of https://github.com/akullpp/awesome-java.git synced 2024-11-20 11:28:01 -05:00
java/CONTRIBUTING.md

41 lines
2.3 KiB
Markdown
Raw Normal View History

2014-07-11 15:47:16 -04:00
# Contribution Guidelines
2017-05-15 23:56:07 -04:00
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:
2014-07-11 15:47:16 -04:00
2017-05-23 13:22:40 -04:00
(a) widely recommended regardless of personal opinion (e.g. 100+ GitHub stars)
2014-07-11 15:47:16 -04:00
(b) highly discussed in the community due to its innovative nature
(c) absolutely unique in its approach and function
2014-07-11 15:47:16 -04:00
2017-05-15 23:56:07 -04:00
(d) a niche product that fills a gap
2017-05-23 13:22:40 -04:00
Suggested software must also be developer-friendly, which means it meets the following criteria:
(i) If an open source application, it is licensed under one of the [permissive](https://opensource.org/faq#permissive) open source licenses listed on [https://opensource.org/licenses](https://opensource.org/licenses).
(ii) If commercial, it has clear pricing.
2017-05-02 07:18:28 -04:00
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.
2017-05-23 13:22:40 -04:00
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.
2017-05-02 07:18:28 -04:00
Self-promotion is frowned upon and will be reviewed critically but the suggestion will of course be approved if they criteria match.
2014-07-11 15:47:16 -04:00
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:
2014-07-11 15:47:16 -04:00
* 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.
2014-07-11 17:46:05 -04:00
* Entries should be sorted in ascending alphabetical order, i.e. a to z.
* New categories, or improvements to the existing categorization are welcome.
2017-05-02 07:18:28 -04:00
* Keep descriptions short, simple and unbiased.
2014-07-11 15:47:16 -04:00
* 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!