-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: consolidated coding guide and added naming conventions table #27213
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
Conversation
87cf806
to
cce1ac6
Compare
cce1ac6
to
4a4496a
Compare
4a4496a
to
1e827d5
Compare
f9f7f62
to
3c5e164
Compare
Attn @timhoffm - I moved things around so much that I figure I should check if I did anything you're opposed to. |
a3514c7
to
5cb6344
Compare
3bce52d
to
c5eb7a2
Compare
c5eb7a2
to
71f4a4e
Compare
c0033f6
to
57f5908
Compare
Thanks for the heads up. I will check later. |
d690302
to
e12c7db
Compare
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
e12c7db
to
5143bad
Compare
@story645 please decide yourself whether you want to backport this. |
@meeseeksdev backport to v3.8-doc |
Something went wrong ... Please have a look at my logs. It seems that the branch you are trying to backport to does not exist. |
@meeseeksdev backport to v3.8.x |
…d naming conventions table
@meeseeksdev backport to v3.8.1-doc |
…d naming conventions table
backported to avoid merge conflicts if smaller changes get backported 😓 |
…213-on-v3.8.x Backport PR #27213 on branch v3.8.x (DOC: consolidated coding guide and added naming conventions table)
…213-on-v3.8.1-doc Backport PR #27213 on branch v3.8.1-doc (DOC: consolidated coding guide and added naming conventions table)
This started as an attempt to document variable naming conventions to address #22156 and well trying to put a table into a bullet list didn't work well and that had me thinking that a bullet list is the wrong structure when tables are involved so 😅 this PR:
While it may not seem like it, I have tried to avoid rewording/rewriting except to remove redundancy. In particularly, I'm trying to remove duplicate sets of detailed instructions b/c I think that creates space for deviation in those instructions/confusion.
Next Steps
I think merging this should be good enough to close #26095 cause it'll at least put everything in one place (mostly). I don't want to overwhelm this PR w/ changes since it's already doing a lot more than I planned, but once this is merged I'd like to clean up the code section of the policy and guidelines page so that it can just be a TOC. To do so, I think a sensible swapping would be to
Basically proposing that the code section of policies & guidelines changes:
and the triage section changes to
or the pull request triage document gets moved to maintenance, but technically I think anyone w/ triage rights can do most of the triage stuff discussed in the pull request guide.