From 55b95122f14d1af62024a300f6b75e04e4a5fd4b Mon Sep 17 00:00:00 2001 From: lpd-au Date: Mon, 20 Feb 2023 00:21:04 +1100 Subject: [PATCH 1/6] Update scope section * Add goal of incorporating PSR-1 style guidelines * Allow for potential future change to PSR-1 to specify PascalCase class constants * Remove vague and meaningless language from non-goals sub-section --- meta.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/meta.md b/meta.md index 0eabf9b..2957eb2 100644 --- a/meta.md +++ b/meta.md @@ -44,18 +44,23 @@ This PER shares the same goals as PSR-12. > of guidelines to be used among all those projects. Thus, the benefit of this guide is > not in the rules themselves, but in the sharing of those rules. -This PER is an extension of PSR-12, and therefore also an extension of PSR-1. +This PER extends, expands and replaces PSR-12, and is therefore also an extension of PSR-1. With PSR-12 being the base of this PER, a list of differences is provided below to assist with migration, but it should be considered as an independent specification. +It is a long term goal of this PER to incorporate requirements found in PSR-1 that exclusively concern coding style, +so that all coding style guidelines can eventually be found in one specification. +However, this PER is not a replacement for PSR-1 and requires adherence to it. + This PER will include coding style guidelines related to new functionality added to PHP -after the publication of PSR-12. This PER will also include clarifications on the text of -PSR-12. +after the publication of PSR-12, as well as clarifications on the text of PSR-12. +It is a goal of this PER to maintain style consistency between old and new PHP syntax. +In rare cases, this may require new releases to include coding style guidelines that break backwards compatibility, limited by the non-goals sub-section below. ### 3.2. Non-Goals -It is not the intention of this PER to add entirely new coding style guidelines. It will -also not change anything stipulated in PSR-1 and PSR-12. +It is not the intention of this PER to significantly alter the coding style guidelines specified in PSR-1 and PSR-12. +It will not change anything stipulated in PSR-1 that concerns technical interoperability or runtime behaviour. ## 4. Approaches From d77c437f522f13470e71edf98938a23da75dc2e5 Mon Sep 17 00:00:00 2001 From: lpd-au Date: Mon, 27 Feb 2023 21:00:28 +1100 Subject: [PATCH 2/6] Update scope section --- meta.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/meta.md b/meta.md index 2957eb2..6868a3a 100644 --- a/meta.md +++ b/meta.md @@ -48,18 +48,20 @@ This PER extends, expands and replaces PSR-12, and is therefore also an extensio With PSR-12 being the base of this PER, a list of differences is provided below to assist with migration, but it should be considered as an independent specification. -It is a long term goal of this PER to incorporate requirements found in PSR-1 that exclusively concern coding style, +It is a long term goal of this PER to incorporate requirements found in PSR-1 that concern coding style, so that all coding style guidelines can eventually be found in one specification. -However, this PER is not a replacement for PSR-1 and requires adherence to it. +However, this PER is not a replacement for PSR-1 and requires adherence to it and any errata. -This PER will include coding style guidelines related to new functionality added to PHP +This PER will include coding style guidelines related to new functionality added to PHP after the publication of PSR-12, as well as clarifications on the text of PSR-12. -It is a goal of this PER to maintain style consistency between old and new PHP syntax. -In rare cases, this may require new releases to include coding style guidelines that break backwards compatibility, limited by the non-goals sub-section below. +It is a goal of this PER to maintain style consistency between related old and new PHP syntax, +such as class constants and constants in enumerations. In rare cases, this may cause new +releases to include coding style guidelines that break backwards compatibility, limited by +the non-goals and versioning sections below. ### 3.2. Non-Goals -It is not the intention of this PER to significantly alter the coding style guidelines specified in PSR-1 and PSR-12. +It is not the intention of this PER to substantially alter the coding style guidelines specified in PSR-1 and PSR-12. It will not change anything stipulated in PSR-1 that concerns technical interoperability or runtime behaviour. ## 4. Approaches From 7b54c7fc8c9b5bb172ddbe9d60c035994a44b07b Mon Sep 17 00:00:00 2001 From: lpd-au Date: Mon, 27 Feb 2023 21:07:49 +1100 Subject: [PATCH 3/6] Remove trailing space --- meta.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meta.md b/meta.md index 6868a3a..7b42d06 100644 --- a/meta.md +++ b/meta.md @@ -52,7 +52,7 @@ It is a long term goal of this PER to incorporate requirements found in PSR-1 th so that all coding style guidelines can eventually be found in one specification. However, this PER is not a replacement for PSR-1 and requires adherence to it and any errata. -This PER will include coding style guidelines related to new functionality added to PHP +This PER will include coding style guidelines related to new functionality added to PHP after the publication of PSR-12, as well as clarifications on the text of PSR-12. It is a goal of this PER to maintain style consistency between related old and new PHP syntax, such as class constants and constants in enumerations. In rare cases, this may cause new From dbf31967207cfe083a0eb38dfab450dbda090bb6 Mon Sep 17 00:00:00 2001 From: lpd-au Date: Mon, 27 Feb 2023 21:48:43 +1100 Subject: [PATCH 4/6] Brevity for scope section --- meta.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/meta.md b/meta.md index 7b42d06..1f828bf 100644 --- a/meta.md +++ b/meta.md @@ -48,7 +48,7 @@ This PER extends, expands and replaces PSR-12, and is therefore also an extensio With PSR-12 being the base of this PER, a list of differences is provided below to assist with migration, but it should be considered as an independent specification. -It is a long term goal of this PER to incorporate requirements found in PSR-1 that concern coding style, +It is a long term goal of this PER to incorporate coding syle requirements found in PSR-1, so that all coding style guidelines can eventually be found in one specification. However, this PER is not a replacement for PSR-1 and requires adherence to it and any errata. @@ -61,7 +61,7 @@ the non-goals and versioning sections below. ### 3.2. Non-Goals -It is not the intention of this PER to substantially alter the coding style guidelines specified in PSR-1 and PSR-12. +It is not the intention of this PER to substantially or arbitrarily alter coding style guidelines found in PSR-1 and PSR-12. It will not change anything stipulated in PSR-1 that concerns technical interoperability or runtime behaviour. ## 4. Approaches From e475776907a91d865269649d2b837e3bc59ce3fe Mon Sep 17 00:00:00 2001 From: lpd-au Date: Wed, 1 Mar 2023 01:53:27 +1100 Subject: [PATCH 5/6] Update meta.md Co-authored-by: Larry Garfield --- meta.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/meta.md b/meta.md index 1f828bf..596771a 100644 --- a/meta.md +++ b/meta.md @@ -48,9 +48,12 @@ This PER extends, expands and replaces PSR-12, and is therefore also an extensio With PSR-12 being the base of this PER, a list of differences is provided below to assist with migration, but it should be considered as an independent specification. -It is a long term goal of this PER to incorporate coding syle requirements found in PSR-1, -so that all coding style guidelines can eventually be found in one specification. -However, this PER is not a replacement for PSR-1 and requires adherence to it and any errata. +This PER will eventually incorporate and replace any stylistic requirements found in PSR-1. +PER-1 includes a number of non-stylistic requirements that affect runtime behavior, which are +out of scope for this PER. + +If a particular rule is mentioned in both this PER and PSR-1, this PER takes precedence. If not, +the PSR-1 rule (including errata) still applies. This PER will include coding style guidelines related to new functionality added to PHP after the publication of PSR-12, as well as clarifications on the text of PSR-12. From 5f1d84391171602eafe4f58ff6f058bd3189ee2f Mon Sep 17 00:00:00 2001 From: lpd-au Date: Wed, 1 Mar 2023 22:03:49 +1100 Subject: [PATCH 6/6] Fixed typo, combined paragraphs --- meta.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/meta.md b/meta.md index 596771a..df2f527 100644 --- a/meta.md +++ b/meta.md @@ -49,11 +49,9 @@ With PSR-12 being the base of this PER, a list of differences is provided below but it should be considered as an independent specification. This PER will eventually incorporate and replace any stylistic requirements found in PSR-1. -PER-1 includes a number of non-stylistic requirements that affect runtime behavior, which are -out of scope for this PER. - -If a particular rule is mentioned in both this PER and PSR-1, this PER takes precedence. If not, -the PSR-1 rule (including errata) still applies. +PSR-1 includes a number of non-stylistic requirements that affect runtime behavior, which are +out of scope for this PER. If a particular rule is mentioned in both this PER and PSR-1, +this PER takes precedence. If not, the PSR-1 rule (including errata) still applies. This PER will include coding style guidelines related to new functionality added to PHP after the publication of PSR-12, as well as clarifications on the text of PSR-12.