Skip to content

chore(claude): prevent code comment proliferation - #1141

Merged
mbevc1 merged 1 commit into
mainfrom
20260829_claude_comments
Aug 30, 2026
Merged

chore(claude): prevent code comment proliferation#1141
mbevc1 merged 1 commit into
mainfrom
20260829_claude_comments

Conversation

@mbevc1

@mbevc1 mbevc1 commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Instruct Claude to not use excessive code comments

Checklist

@mbevc1
mbevc1 marked this pull request as ready for review August 29, 2026 21:44
@mbevc1
mbevc1 enabled auto-merge (squash) August 29, 2026 21:45
@github-actions github-actions Bot added documentation Improvements or additions to documentation chore labels Aug 29, 2026
@claude

claude Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 1m 6s —— View job


Review — chore(claude): prevent code comment proliferation

  • Read PR context and prior review rounds
  • Diff origin/main...HEAD
  • Assess placement, wording, and file conventions
  • Post feedback

Verdict

Looks good — approve-equivalent, nothing blocking. Docs-only (CLAUDE.md, +6/-0); no Go files touched, so go build / go vet / go mod tidy checks aren't applicable to this diff.

What changed since the earlier rounds

The block landed in the right place and the earlier substantive concerns are resolved:

  • ✅ Moved out of ### Principles (slice-granularity list) into ## Working Style: TDD, directly after the loop — where cleanup guidance belongs.
  • Also make sure to: is now its own lead-in sentence rather than being grammatically glued to "…then commit any remaining cleanup", so the bullets read as standing rules instead of post-commit steps.
  • ✅ Bullets use - to match the other 45 bullets in the file.
  • ✅ The double-em-dash is gone — not *what*; the code already says… now separates the two independent clauses cleanly.
  • Repeat steps 2–7 is accurate again (the loop is back to 7 steps).
  • ✅ Carving out godoc comments on exported identifiers is the right call — a blanket "minimal comments" rule would otherwise fight Go convention and golint-style expectations.

Remaining nits (optional)

Two cosmetics, left inline with a suggestion:

  1. Hard wrapCLAUDE.md:119-121 wraps at ~95 chars; every other bullet/paragraph in the file is a single unwrapped line, making this the only wrapped block in the document.
  2. Repeated verb — "Follow good practices — follow industry practices…"; the useful half is "the patterns already established in this codebase".

Neither affects how Claude reads the file. Merge as-is if you'd rather stop iterating.

One thing worth considering

## Working Style: TDD scopes these rules to the TDD loop. Since "keep comments minimal" and "follow existing patterns" apply to all work in this repo (doc edits, config, one-off fixes), a top-level ## Code Style section would be marginally more discoverable. Given the file is read whole on every session, this is a stylistic preference, not a functional gap. Fix this →


Note: the checked-out working tree had this change reverted locally (M CLAUDE.md) — a runner artifact; I did not commit anything. Review is against the pushed commit b678f83.
· 20260829_claude_comments

Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md
Comment thread CLAUDE.md Outdated
@mbevc1
mbevc1 force-pushed the 20260829_claude_comments branch from b8e844f to b843a55 Compare August 29, 2026 22:05
Comment thread CLAUDE.md Outdated
@mbevc1
mbevc1 force-pushed the 20260829_claude_comments branch from b843a55 to bb1f459 Compare August 29, 2026 22:10
Comment thread CLAUDE.md
@mbevc1
mbevc1 force-pushed the 20260829_claude_comments branch from bb1f459 to 57c2e85 Compare August 29, 2026 22:13
Comment thread CLAUDE.md
@mbevc1
mbevc1 merged commit c85fd4e into main Aug 30, 2026
22 checks passed
@mbevc1
mbevc1 deleted the 20260829_claude_comments branch August 30, 2026 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants