Skip to content

docs(claude): add the deletion test for code comments #384

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

Open
etrobert-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(claude): add the deletion test for code comments #384

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
4 changes: 4 additions & 0 deletions pkgs/claude-code-wrapped/config/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ point — the gotcha or "why" — and leave narrative context (root-cause chains
incident history) for the commit or PR. A two-line change rarely needs more than
a two-line comment.

Apply the deletion test: if a comment only restates what the code, filename, or
option names already convey, cut it. Don't describe how or where code is wired
up (e.g. which hosts import a module).

## Testing

Before committing, verify the change: typecheck, lint, and run the relevant
Expand Down
Loading