awesome-php/CONTRIBUTING.md

27 lines
1.6 KiB
Markdown
Raw Normal View History

2013-12-30 07:33:17 +00:00
# Contribution Guidelines
2016-01-21 23:52:04 +00:00
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
2016-01-21 23:52:04 +00:00
a) Be widely recommended regardless of personal opinion
b) Well known or discussed within the PHP community
c) Be unique in its approach or function
d) 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:
2016-01-21 23:52:04 +00:00
* Software that is PHP 5.5+, Composer-installable, PSR compliant, united tested and well documented is preferred.
2013-12-30 23:47:47 +00:00
* Please search previous suggestions before making a new one, as yours may be a duplicate.
* Enter a meaningful pull request description.
2014-08-05 16:13:14 +00:00
* Please make an individual commit for each suggestion in a pull request.
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.
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.
* New categories, or improvements to the existing categorisation, are always welcome.
2016-01-21 23:52:04 +00:00
* Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon.
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.
2013-12-30 07:33:17 +00:00
2014-07-11 19:57:44 +00:00
Thank you for your suggestions!