-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Include the acronym casing RFC in coding-standards-and-naming.rst #7
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if the policy should be an evolving document, Derick will know that.
But the contents itself look good.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea behind these documents is that they update the actual text — not adding a new section that has changes to already existing text.
At the top, you can do something like:
https://github.com/php/policies/blob/main/release-process.rst?plain=1#L8
My understanding is that the coding-standards-and-naming.rst has not yet been cleaned up following the “Policy Repository” RFC:
… and thus still is the concatenation of the relevant RFCs instead of a properly written policy document. I feel that editing around in the existing non-cleaned-up state would make things worse rather than better, because the result is neither a coherent text, nor does it match the RFC texts that are authoritative as-of now. |
In fact as per my understanding of the “Policy Repository” RFC, the cleaning up requires another RFC to confirm that no unintended changes have been introduced:
The previous PR for the release cycle update is already merged and thus to my understanding violates that decision. |
Hmm, you're right. I had missed that from my own RFC :-). The question is... does it actually make sense to do? But I would also say, that it probably have been wise to cover that in your "acronym casing policy" RFC so that we don't need to do it twice! |
OK, please merge this then. I will then start working on fixing up all the language and put it up for an RFC. |
Sorry, didn't get around to this over the weekend and was busy last week.
I've written the RFC in a way such that it makes a well-defined change to the CODING_STANDARDS.md. That one is the more complete file, compared to the stuff in the policies repository and thus is probably the best source for the rewrite.
I don't have the commit bit for this repository, someone else will need to merge.
Thank you. |
see https://wiki.php.net/rfc/class-naming-acronyms
Companion RFC in php/php-src#14169.
/cc @Crell @nielsdos @Girgias