Add Code Style Principles section to CLAUDE.md#18713
Merged
harupy merged 2 commits intomlflow:masterfrom Nov 6, 2025
Merged
Conversation
Updated the Code Style Principles section for better clarity and consistency: - Changed "Import at top-level" to "Use top-level imports" for clearer action - Replaced negative framing with positive framing for docstrings and comments - All principles now consistently use "only" pattern to guide when to add code elements 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
commented
Nov 6, 2025
Comment on lines
+7
to
+12
| ## Code Style Principles | ||
|
|
||
| - Use top-level imports (only use lazy imports when necessary) | ||
| - Only add test docstrings when they provide additional context | ||
| - Only add comments that explain non-obvious logic or provide additional context | ||
|
|
Member
Author
There was a problem hiding this comment.
We could add this in dev/guides/python.md but I've never seen Claude Code read it
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
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 changes are proposed in this pull request?
This PR adds a new Code Style Principles section to CLAUDE.md to provide clear guidance for code contributions.
The new principles are:
These principles help maintain code quality by encouraging clean imports, meaningful documentation, and purposeful comments.
How is this PR tested?
This is a documentation-only change to CLAUDE.md guidance.
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
How should the PR be classified in the release notes? Choose one:
rn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionShould this PR be included in the next patch release?
🤖 Generated with Claude Code