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

52 lines
2.6 KiB
Markdown
Raw Normal View History

2014-07-11 15:47:16 -04:00
# Contribution Guidelines
2017-05-23 18:16:55 -04:00
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:
2014-07-11 15:47:16 -04:00
(a) widely recommended, regardless of personal opinion
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
2020-02-02 04:04:25 -05:00
(d) a niche product that fills a gap
2017-05-15 23:56:07 -04:00
2020-02-02 04:04:25 -05:00
Suggested software must also be developer-friendly, which means it meets the following criteria:
2017-05-23 14:11:47 -04:00
2020-02-02 04:04:25 -05:00
(i) If an open source _application_, it is licensed under one of the open source licenses listed on https://opensource.org/licenses.
2017-05-23 14:09:44 -04:00
2020-02-02 04:04:25 -05:00
(ii) If an open source _library_, it is licensed under one of the open source licenses listed on https://opensource.org/licenses, with the exception of GPL and AGPL (due to their viral nature).
2017-05-23 14:09:44 -04:00
(iii) If commercial, it has clear pricing and at least one free tier.
(iv) It has a documentation in the English language.
2020-02-02 04:04:25 -05:00
## Pull Requests
2017-05-23 14:11:47 -04:00
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.
2020-02-02 04:04:25 -05: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
2020-02-02 04:04:25 -05:00
3. If an entry doesn't fit any of the pre-existing specialized sections, it should go under Miscellaneous.
2017-09-20 02:36:51 -04:00
2020-02-02 04:04:25 -05:00
4. If two or more entries in Miscellaneous are in the same domain, then they can be moved to a new specialized section.
2017-09-20 02:36:51 -04:00
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.
2014-07-11 15:47:16 -04:00
Furthermore, please ensure your pull request follows the following guidelines:
2014-07-11 15:47:16 -04:00
2020-02-02 04:04:25 -05: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.
- 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.
- End all descriptions with a full stop/period.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
2014-07-11 15:47:16 -04:00
Thank you for your suggestions!