awesome-php/CONTRIBUTING.md

28 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2013-12-30 07:33:17 +00:00
# Contribution Guidelines
Unfortunately, not every library, tool or framework can be considered for inclusion. The aim of Awesome PHP is to be a concise list of noteworthy and interesting software written in modern PHP. Therefore, suggested software should:
2013-12-30 07:33:17 +00:00
2020-05-11 22:05:55 +00:00
1. Be widely recommended
2017-03-26 12:56:21 +00:00
2. Well known or discussed within the PHP community
3. Be unique in its approach or function
4. Fill a niche gap in the market
2016-01-21 23:45:05 +00:00
2016-01-21 23:53:02 +00:00
Self-promotion is frowned upon, so please consider seriously whether your project meets the criteria before opening a pull request, otherwise it may be closed without being reviewed.
2016-01-21 23:45:05 +00:00
Also, please ensure your pull request adheres to the following guidelines:
2022-05-31 08:15:01 +00:00
* Software that is PHP 8.0+, Composer-installable, PSR compliant, semantically versioned, unit tested, actively maintained and well documented in English.
* Please search previous suggestions before making a new one, as yours may be a duplicate and will be closed.
* Enter a meaningful pull request description.
2016-01-21 23:45:05 +00:00
* Put a link to each library in your pull request ticket so it's easier to review.
2022-05-31 08:15:01 +00:00
* Please make an individual commit for each suggestion in a separate pull request.
2013-12-30 23:47:47 +00:00
* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
* Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar.
2022-05-31 09:15:33 +00:00
* New categories, or improvements to the existing categorisation, are always welcome.
2022-05-31 08:15:01 +00:00
* Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon please.
2013-12-30 23:47:47 +00: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.
2020-05-11 22:05:55 +00:00
* Your entry has been added alphabetically within the category.
2013-12-30 07:33:17 +00:00
2014-07-11 19:57:44 +00:00
Thank you for your suggestions!