From faf08f5935c00b5599f5ee06a71d66166266bd08 Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:24:51 +0100 Subject: [PATCH 1/9] simplify guidelines --- CONTRIBUTING.md | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21a95e700..6c8c5f53b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,33 @@ # 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: +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: -1. Be widely recommended -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 +* Widely known or recognised within the PHP community +* Established and mature +* Unique in its approach +* Fulfill a niche gap in the market -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. +Where applicable, preference will be give to software that: + +* Targets supported versions of PHP +* Installable using Composer +* PSR compliant +* Semantically versioned +* Thoroughly tested +* Actively maintained +* Well documented in English Also, please ensure your pull request adheres to the following guidelines: -* 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. -* Put a link to each library in your pull request ticket so it's easier to review. -* Please make an individual commit for each suggestion in a separate pull request. -* 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. -* Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon please. -* End all descriptions with a full stop/period. -* Check your spelling and grammar. -* Make sure your text editor is set to remove trailing whitespace. -* Your entry has been added alphabetically within the category. +* Your suggestion is not a duplicate or has been previously rejected, otherwise it will be closed. +* Write a meaningful pull request description which includes a link to the project. +* Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.` +* Your description is short, clear, unbiased, and doesn't contain any jargon. +* The description ends with a full stop/period, and has no trailing whitespace. +* Your spelling and grammar are correct. +* Your entry is added alphabetically to the category. +* The library is prefixed with the vendor name (e.g. `Foo\Bar` becomes `Foo Bar`) if it shares the same name as another entry. +* Feel free to suggest new categories or organisational improvements. + +Please make sure your suggestion meets all the criteria before submitting a pull request, or it may be closed without review. Thank you for your suggestions! From 506cdf337c0f6a18dac828b3ab00d72066f1e4c3 Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:29:24 +0100 Subject: [PATCH 2/9] tweak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c8c5f53b..7353231a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Where applicable, preference will be give to software that: Also, please ensure your pull request adheres to the following guidelines: -* Your suggestion is not a duplicate or has been previously rejected, otherwise it will be closed. +* Your suggestion hasn't been previously rejected or is a duplicate, otherwise it will be closed. * Write a meaningful pull request description which includes a link to the project. * Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.` * Your description is short, clear, unbiased, and doesn't contain any jargon. From 41a150e97eb9a59aac7bf0fcfe8828008c59d4c9 Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:29:59 +0100 Subject: [PATCH 3/9] tweak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7353231a1..97d5760ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Also, please ensure your pull request adheres to the following guidelines: * Write a meaningful pull request description which includes a link to the project. * Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.` * Your description is short, clear, unbiased, and doesn't contain any jargon. -* The description ends with a full stop/period, and has no trailing whitespace. +* The description ends with a full stop/period and no trailing whitespace. * Your spelling and grammar are correct. * Your entry is added alphabetically to the category. * The library is prefixed with the vendor name (e.g. `Foo\Bar` becomes `Foo Bar`) if it shares the same name as another entry. From 7767f40c77ccef984e06490f3e9d8432e25a4113 Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:31:35 +0100 Subject: [PATCH 4/9] tweak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97d5760ef..15f361f86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Also, please ensure your pull request adheres to the following guidelines: * Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.` * Your description is short, clear, unbiased, and doesn't contain any jargon. * The description ends with a full stop/period and no trailing whitespace. -* Your spelling and grammar are correct. +* You've checked your spelling and grammar. * Your entry is added alphabetically to the category. * The library is prefixed with the vendor name (e.g. `Foo\Bar` becomes `Foo Bar`) if it shares the same name as another entry. * Feel free to suggest new categories or organisational improvements. From 1897c854b89b9a665d786edcb75b7dca679ba9f1 Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:33:06 +0100 Subject: [PATCH 5/9] tweak --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15f361f86..768ebb7c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,8 @@ The aim of Awesome PHP is to be a concise list of the best packages, frameworks, Where applicable, preference will be give to software that: * Targets supported versions of PHP -* Installable using Composer -* PSR compliant +* Can be installed using Composer +* Is PSR compliant * Semantically versioned * Thoroughly tested * Actively maintained From 7c2851a2a45154099062b3dea8e0fc745e73acbb Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:43:47 +0100 Subject: [PATCH 6/9] tweak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 768ebb7c1..b9ecd3b4c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Where applicable, preference will be give to software that: Also, please ensure your pull request adheres to the following guidelines: -* Your suggestion hasn't been previously rejected or is a duplicate, otherwise it will be closed. +* Your suggestion will be closed if it has been previously rejected or is a duplicate. * Write a meaningful pull request description which includes a link to the project. * Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.` * Your description is short, clear, unbiased, and doesn't contain any jargon. From fee48a4fce0efdccb78d0170a740cc29e7b8b805 Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:46:10 +0100 Subject: [PATCH 7/9] tweak --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9ecd3b4c..c7c697e0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,15 +18,15 @@ Where applicable, preference will be give to software that: Also, please ensure your pull request adheres to the following guidelines: -* Your suggestion will be closed if it has been previously rejected or is a duplicate. -* Write a meaningful pull request description which includes a link to the project. +* Your suggestion will be closed if it has been previously rejected or is a duplicate +* Write a meaningful pull request description which includes a link to the project * Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.` -* Your description is short, clear, unbiased, and doesn't contain any jargon. -* The description ends with a full stop/period and no trailing whitespace. -* You've checked your spelling and grammar. -* Your entry is added alphabetically to the category. -* The library is prefixed with the vendor name (e.g. `Foo\Bar` becomes `Foo Bar`) if it shares the same name as another entry. -* Feel free to suggest new categories or organisational improvements. +* Your description is short, clear, unbiased, and doesn't contain any jargon +* The description ends with a full stop/period and no trailing whitespace +* You've checked your spelling and grammar +* Your entry is added alphabetically to the category +* If your entry has the same name as another, it should be prefixed with the vendor (e.g., `Foo\Bar` becomes `Foo Bar`) +* Feel free to suggest new categories or organisational improvements Please make sure your suggestion meets all the criteria before submitting a pull request, or it may be closed without review. From b3a61b72f066f2cc4606671ef43634862c39f0be Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 15:49:45 +0100 Subject: [PATCH 8/9] tweak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c7c697e0c..5c4a506ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # Contribution Guidelines -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: +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: * Widely known or recognised within the PHP community * Established and mature From 53e0c5c4d5524797950da61c980f83e814111f52 Mon Sep 17 00:00:00 2001 From: Jamie York Date: Sun, 1 Sep 2024 20:30:30 +0100 Subject: [PATCH 9/9] tweaks --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c4a506ed..f9ed3d4ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ # Contribution Guidelines -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: +Awesome PHP aims 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. The suggested software should ideally be one of the following: * Widely known or recognised within the PHP community * Established and mature * Unique in its approach * Fulfill a niche gap in the market -Where applicable, preference will be give to software that: +Where applicable, preference will be given to software that: * Targets supported versions of PHP * Can be installed using Composer @@ -19,7 +19,7 @@ Where applicable, preference will be give to software that: Also, please ensure your pull request adheres to the following guidelines: * Your suggestion will be closed if it has been previously rejected or is a duplicate -* Write a meaningful pull request description which includes a link to the project +* Write a meaningful pull request description that includes a link to the project * Adheres to the following Markdown format: `[LIBRARY](LINK) - DESCRIPTION.` * Your description is short, clear, unbiased, and doesn't contain any jargon * The description ends with a full stop/period and no trailing whitespace