Przeglądaj źródła

simplify guidelines

pull/1304/head
Jamie York 1 rok temu
rodzic
commit
faf08f5935
1 zmienionych plików z 25 dodań i 19 usunięć
  1. 25
    19
      CONTRIBUTING.md

+ 25
- 19
CONTRIBUTING.md Wyświetl plik

@@ -1,27 +1,33 @@
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
+The aim of Awesome PHP is to be a concise list of the best packages, frameworks, tools and software the PHP ecosystem has to offer. Unfortunately this means not everything can or should be included. Therefore, suggested software should ideally be one of the following:
3 3
 
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
4
+* Widely known or recognised within the PHP community
5
+* Established and mature
6
+* Unique in its approach
7
+* Fulfill a niche gap in the market
8 8
 
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.
9
+Where applicable, preference will be give to software that:
10
+
11
+* Targets supported versions of PHP
12
+* Installable using Composer
13
+* PSR compliant
14
+* Semantically versioned
15
+* Thoroughly tested
16
+* Actively maintained
17
+* Well documented in English
10 18
 
11 19
 Also, please ensure your pull request adheres to the following guidelines:
12 20
 
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
-* Enter a meaningful pull request description.
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
-* 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.
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 please.
22
-* End all descriptions with a full stop/period.
23
-* Check your spelling and grammar.
24
-* Make sure your text editor is set to remove trailing whitespace.
25
-* Your entry has been added alphabetically within the category.
21
+* Your suggestion is not a duplicate or has been previously rejected, otherwise it will be closed.
22
+* Write a meaningful pull request description which includes a link to the project.
23
+* Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.`
24
+* Your description is short, clear, unbiased, and doesn't contain any jargon.
25
+* The description ends with a full stop/period, and has no trailing whitespace.
26
+* Your spelling and grammar are correct.
27
+* Your entry is added alphabetically to the category.
28
+* The library is prefixed with the vendor name (e.g. `Foo\Bar` becomes `Foo Bar`) if it shares the same name as another entry.
29
+* Feel free to suggest new categories or organisational improvements.
30
+
31
+Please make sure your suggestion meets all the criteria before submitting a pull request, or it may be closed without review.
26 32
 
27 33
 Thank you for your suggestions!

Ładowanie…
Anuluj
Zapisz