|
|
@@ -1,26 +1,27 @@
|
|
1
|
1
|
# Contribution Guidelines
|
|
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:
|
|
|
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 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
|
|
|
4
|
+1. Be widely recommended
|
|
|
5
|
+2. Well known or discussed within the PHP community
|
|
|
6
|
+3. Be unique in its approach or function
|
|
|
7
|
+4. Fill a niche gap in the market
|
|
8
|
8
|
|
|
9
|
9
|
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.
|
|
10
|
10
|
|
|
11
|
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, semantically versioned, united tested and well documented in English is preferred.
|
|
14
|
|
-* Please search previous suggestions before making a new one, as yours may be a duplicate.
|
|
|
13
|
+* Software that is PHP 8.0+, Composer-installable, PSR compliant, semantically versioned, unit tested, actively maintained and well documented in English.
|
|
|
14
|
+* Please search previous suggestions before making a new one, as yours may be a duplicate and will be closed.
|
|
15
|
15
|
* Enter a meaningful pull request description.
|
|
16
|
|
-* Please make an individual commit for each suggestion in a separate pull request.
|
|
17
|
16
|
* Put a link to each library in your pull request ticket so it's easier to review.
|
|
|
17
|
+* Please make an individual commit for each suggestion in a separate pull request.
|
|
18
|
18
|
* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
|
|
19
|
19
|
* Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar.
|
|
20
|
20
|
* New categories, or improvements to the existing categorisation, are always welcome.
|
|
21
|
|
-* Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon.
|
|
|
21
|
+* Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon please.
|
|
22
|
22
|
* End all descriptions with a full stop/period.
|
|
23
|
23
|
* Check your spelling and grammar.
|
|
24
|
24
|
* Make sure your text editor is set to remove trailing whitespace.
|
|
|
25
|
+* Your entry has been added alphabetically within the category.
|
|
25
|
26
|
|
|
26
|
27
|
Thank you for your suggestions!
|