Skip to content

docs: add CLAUDE.md with comment guidance for Claude Code #404

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.

Sign up for GitHub

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

Merged
bobluppes merged 1 commit into from
Sep 12, 2026
Merged

docs: add CLAUDE.md with comment guidance for Claude Code #404

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Comments

Only use comments to call out non-obvious rationale or design choices (e.g. why a particular approach was taken, a workaround for a specific limitation, or a subtle invariant) — not to restate what the code already makes clear. Prefer solutions that are self-documenting through clear names and proper abstraction instead of relying on comments to explain what the code does.

Never leak implementation details in documentation comments on public APIs. Document what a public API does and how to use it, not how it is implemented internally — internal details belong in the implementation, not in the public-facing doc comment.
Loading