Skip to content

chore(claude): prevent code comment proliferation #1141

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
mbevc1 merged 1 commit into from
Aug 30, 2026
Merged

chore(claude): prevent code comment proliferation #1141

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
6 changes: 6 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,12 @@ Follow a strict Red-Green-Refactor loop for every change:

Repeat steps 2–7 until the slice is complete, then commit any remaining cleanup.

Also make sure to:
- **Follow good practices** — follow industry practices and existing patterns in the codebase.
- **Keep code comments minimal** — comment on *why*, not *what*; the code already says what it
does. Add a comment only for non-obvious intent, constraints, or workarounds. Keep godoc
comments on exported identifiers.
Comment thread
mbevc1 marked this conversation as resolved.
Comment thread
mbevc1 marked this conversation as resolved.
Comment thread
mbevc1 marked this conversation as resolved.

### Test list discipline

Maintain the test list in `TODO.md` under the active slice (see Thin Vertical Slices below). Before writing code, brainstorm the tests you expect to write. During the loop, add new tests as you discover them. The list is a living document — it grows and shrinks as understanding deepens.
Expand Down
Loading