Re: [RFC] Consolidate Coding Standards Policy Document

From: Date: Tue, 24 Dec 2024 19:11:27 +0000
Subject: Re: [RFC] Consolidate Coding Standards Policy Document
References: 1  Groups: php.internals 
Request: Send a blank email to [email protected] to get a copy of this message
> On Dec 23, 2024, at 19:06, Derick Rethans <[email protected]> wrote:
> 
> On Sun, 22 Dec 2024, Ben Ramsey wrote:
> 
>>> On Wed, Dec 18, 2024 at 11:39 Derick Rethans <[email protected]> wrote:
>>> 
>>> I would like to propose the "Consolidate Coding Standards Policy
>>> Document" RFC, which follows up from the Policy Repository RFC[1]'s
>>> future scope section.
>>> 
>>> This proposal suggests adopting the changes to the Coding Standards
>>> and Naming document, and to integrate the CODING_STANDARDS.md file
>>> from the php-src repository:
>>> 
>>> https://wiki.php.net/rfc/consolidate-coding-standard-policy-document
>>> 
>>> [1] https://wiki.php.net/rfc/policy-repository
>> 
>> Nitpick:
>> 
>> It might be more correct to reference BCP 14[1] instead of RFC 2119
>> (which is part of BCP 14).
>> 
>> [1] https://www.rfc-editor.org/info/bcp14
> 
> Either works really? I think that if I would feel inclined to update it,
> wouldn't I just mention RFC 8174, as it updates 2119?
> 
> Many (if not most) documents I have seen still reference to RFC 2119
> though...


The latest RFCs from the IETF standards track use language like this:

> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
> "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",
> "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
> interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
> capitals, as shown here.


See here for an example: https://www.rfc-editor.org/rfc/rfc9697.html#section-1.1

Cheers,
Ben




Thread (5 messages)

« previous php.internals (#126174) next »