| Next revision | Previous revision |
| rfc:consolidate-coding-standard-policy-document [2024/12/16 13:53] – created derick | rfc:consolidate-coding-standard-policy-document [2025/01/28 15:54] (current) – derick |
|---|
| * Date: 2014-12-16 | * Date: 2014-12-16 |
| * Author: Derick Rethans <derick@php.net> | * Author: Derick Rethans <derick@php.net> |
| * Status: Under Discussion | * Status: Voting |
| * First Published at: http://wiki.php.net/rfc/consolidate-coding-standard-policy-document | * First Published at: http://wiki.php.net/rfc/consolidate-coding-standard-policy-document |
| |
| This proposal suggests adopting the changes to the [[https://github.com/php/policies/blob/main/coding-standards-and-naming.rst|Coding Standards and Naming]] document, and to integrate the [[https://github.com/php/php-src/blob/master/CODING_STANDARDS.md|CODING_STANDARDS.md]] file from the php-src repository. | This proposal suggests adopting the changes to the [[https://github.com/php/policies/blob/main/coding-standards-and-naming.rst|Coding Standards and Naming]] document, and to integrate the [[https://github.com/php/php-src/blob/master/CODING_STANDARDS.md|CODING_STANDARDS.md]] file from the php-src repository. |
| |
| The patch is available at https://github.com/php/policies/pull/11 for review. It has been converted to use RFC 2119 terminology (SHOULD, MUST, etc), mimicking as close as possible the original intended meaning of the text from "Coding Standards and Naming". Specifically, the original document used "should" a lot, where it really meant MUST. Preliminary review by a select few has tweaked the terms to be as close as possible. | The patch is available at https://github.com/php/policies/pull/11 for review. It has been converted to use BCP 14/RFC 2119 terminology (SHOULD, MUST, etc), mimicking as close as possible the original intended meaning of the text from "Coding Standards and Naming". Specifically, the original document used "should" a lot, where it really meant MUST. Preliminary review by a select few has tweaked the terms to be as close as possible. |
| | '' |
| | The integration of the'' CODING_STANDARDS.md file followed, and only includes minor changes to the text, again, specifically to use the BCP 14/RFC 2119 terminology. In addition, a separate commit modifies some ''CODING_STANDARD.md'' language to document certain current behaviour, which the original document was never updated for, in a specific commit: https://github.com/php/policies/pull/11/commits/f534be73970355c1cffc4be17078795ee5cab5b9 |
| |
| The integration of the CODING_STANDARDS.md file followed, and only includes minor changes to the text, again, specifically to use the RFC 2119 terminology. | As part of the RFC process, wording in the associated Pull Request can be updated, up until the vote opens. Deviations to currently documented guidelines will remain in a separate commit before merging. |
| | |
| As part of the RFC process, wording in the associated Pull Request can be updated, up until the vote opens. | |
| |
| ===== Proposed Voting Choices ===== | ===== Proposed Voting Choices ===== |
| |
| 2/3rds majority required. | 2/3rds majority required. The vote runs until January 28th, 16:00 UTC. |
| |
| <doodle title="Rewrite Coding Standards and Naming Document with Suggested Patch?" auth="derick" voteType="single" closed="true"> | <doodle title="Rewrite Coding Standards and Naming Document with Suggested Patch?" auth="derick" voteType="single" closed="true"> |