DOC: add consolidated developer code guidelines (phase 1) #33851 #63166
+426
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jbrockmendel
added
the
AI Slop
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Add a canonical developer-facing code guidelines document at
doc/source/development/code_guidelines.rstand a one-line whatsnew note indoc/source/whatsnew/next.rst.Why
Consolidates scattered contributor guidance into a single, discoverable reference to reduce reviewer friction and prepare Phase 2 for CI- and linter-rule extraction with minimal bad/good examples.
Scope
Content-only; no code or CI changes.
How to review
doc/source/development/code_guidelines.rstfor clarity, completeness, and Sphinx validity.make -C doc html) orsphinx-build -b html doc/source doc/build/html.doc/source/whatsnew/next.rst) is present.Reviewer checklist