|
|
|
|
|
|
1
|
# Contribution Guidelines
|
1
|
# Contribution Guidelines
|
|
2
|
-Unfortunately, not every library, tool or framework can be considered. The aim of Awesome PHP is to be a concise list of noteworthy and interesting software written in modern PHP. Therefore, suggested software should:
|
|
|
|
|
|
2
|
+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:
|
|
3
|
|
3
|
|
|
4
|
-a) Be widely recommend regardless of personal opinion
|
|
|
|
5
|
-b) Well known or discussed in the PHP community
|
|
|
|
6
|
-c) Be unique in its approach or function
|
|
|
|
7
|
-d) Fill a niche gap in the market
|
|
|
|
|
|
4
|
+a) Be widely recommended regardless of personal opinion
|
|
|
|
5
|
+b) Well known or discussed within the PHP community
|
|
|
|
6
|
+c) Be unique in its approach or function
|
|
|
|
7
|
+d) Fill a niche gap in the market
|
|
8
|
|
8
|
|
|
9
|
-Self-promotion is frowned upon, so please seriously consider whether your project meets the above criteria before making a suggestion, otherwise it may be closed without being reviewed.
|
|
|
|
|
|
9
|
+Self-promotion is frowned upon, so please consider seriously whether your project meets the criteria before open a pull request, otherwise it may be closed without being reviewed.
|
|
10
|
|
10
|
|
|
11
|
Also, please ensure your pull request adheres to the following guidelines:
|
11
|
Also, please ensure your pull request adheres to the following guidelines:
|
|
12
|
|
12
|
|
|
13
|
-* Software that is PHP 5.5+, Composer-installable, PSR compliant, united tested and well documented are preferred.
|
|
|
|
|
|
13
|
+* Software that is PHP 5.5+, Composer-installable, PSR compliant, united tested and well documented is preferred.
|
|
14
|
* Please search previous suggestions before making a new one, as yours may be a duplicate.
|
14
|
* Please search previous suggestions before making a new one, as yours may be a duplicate.
|
|
15
|
* Enter a meaningful pull request description.
|
15
|
* Enter a meaningful pull request description.
|
|
16
|
* Please make an individual commit for each suggestion in a pull request.
|
16
|
* Please make an individual commit for each suggestion in a pull request.
|
|
|
|
|
|
|
18
|
* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
|
18
|
* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
|
|
19
|
* Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar.
|
19
|
* Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar.
|
|
20
|
* New categories, or improvements to the existing categorisation, are always welcome.
|
20
|
* New categories, or improvements to the existing categorisation, are always welcome.
|
|
21
|
-* Keep descriptions short, simple and unbiased.
|
|
|
|
|
|
21
|
+* Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon.
|
|
22
|
* End all descriptions with a full stop/period.
|
22
|
* End all descriptions with a full stop/period.
|
|
23
|
* Check your spelling and grammar.
|
23
|
* Check your spelling and grammar.
|
|
24
|
* Make sure your text editor is set to remove trailing whitespace.
|
24
|
* Make sure your text editor is set to remove trailing whitespace.
|