DOC: Add unified code guideline document (#33851) #61840
Closed
+175
−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
### Summary This PR addresses Issue #33851 by adding a new consolidated documentation file named `code_guidelines.md` under `doc/source/development/`. The purpose is to unify the various coding style and contribution guidelines that were previously scattered across multiple locations such as: - `code_style.html` - `contributing.html#code-standards` ### Why This Change? Many new contributors struggle to find a complete set of code formatting rules. Some style guidelines are embedded in scripts, others in separate docs. This unified document: - Reduces guesswork for contributors - Minimizes repetitive code review comments - Increases visibility and onboarding efficiency ### What's Included ✅ A new file `code_guidelines.md` that includes: - Formatting with `black`, `flake8`, and `isort` - Import ordering conventions - Usage of f-strings, type checking, and `None` comparisons - Function and variable naming rules - Docstring formatting using `numpydoc` - Testing standards using `pytest` - Git commit and PR hygiene - Reference links to official tools and standards ### Follow-up Actions - [ ] Optionally link this in `index.rst` under `doc/source/development/` for visibility in the sidebar - [ ] Receive feedback from maintainers for refinement or integration with existing content --- Let me know if any refinements or reorganization are needed. Happy to make the changes based on your feedback.
|
Hi team 👋, All checks have passed ✅. Please let me know if anything needs to be revised — happy to make changes! Thanks for reviewing 🙏 |
|
Hi team 👋, All checks have passed ✅. Please let me know if anything needs to be revised — happy to make changes! Thanks for reviewing 🙏 |
|
Thanks for the PR but this seems incorporate little to no information in the current contribution documentation. And as a reminder, we discourage the use of AI code contributions. Closing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR addresses Issue #33851 by adding a new consolidated documentation file named
code_guidelines.mdunderdoc/source/development/. The goal is to unify coding standards and make it easier for new contributors to find all code style rules in one place.Key Highlights
code_style.htmlcontributing.html#code-standardsblack,flake8,isort)Let me know if you'd like me to update links in
index.rstor make any changes. Happy to collaborate on refinements.