Skip to content

Document Claude code readability conventions#355

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 1 commit into
masterfrom
sdkennedy2/update-claude-code-style-guidance
May 12, 2026
Merged

Document Claude code readability conventions#355
gh-worker-dd-mergequeue-cf854d[bot] merged 1 commit into
masterfrom
sdkennedy2/update-claude-code-style-guidance

Conversation

@sdkennedy2

@sdkennedy2 sdkennedy2 commented May 11, 2026

Copy link
Copy Markdown
Collaborator

Motivation

Clarify the repository guidance for AI-assisted code edits so generated changes favor readable, reviewable code over compact expressions.

Changes

Adds two Claude code style conventions:

  • Comments should live on their own line above the code they describe, rather than beside code.
  • Function calls should not be passed directly as arguments to other function calls; the inner result should be assigned to a named local first.

These rules make intermediate values easier to inspect, give comments room to explain intent, and reduce dense one-line expressions in future generated changes.

QA Instructions

Documentation-only change. Review the updated CLAUDE.md guidance and confirm the conventions are clear.

Blast Radius

No runtime impact. This only changes repository guidance for future Claude-generated edits.

Documentation

sdkennedy2 commented May 11, 2026

Copy link
Copy Markdown
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@sdkennedy2 sdkennedy2 changed the title Update Claude code style guidance Document Claude code readability conventions May 11, 2026
@sdkennedy2
sdkennedy2 marked this pull request as ready for review May 11, 2026 14:48
@sdkennedy2
sdkennedy2 requested a review from yoannmoinet as a code owner May 11, 2026 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants