comments
Installation
SKILL.md
Comments Cleanup
Scan the diff you just produced and strip comments that the code already carries. The comments rule has the long-form criteria and examples; this skill is the cleanup procedure.
Procedure
- Pull the diff.
git difffor unstaged work,git diff --stagedfor staged. Focus on+-lines that introduced comments. - For each new comment, ask one question — would a competent reader miss anything if this comment were removed? If the answer is no, delete the comment.
- Tighten what remains. A comment that stays should describe why, fit on one line where possible, and use the language's doc-comment syntax for public APIs only.
Categories to delete on sight
- Narration — restates what the code does (
// increment counter,// loop through users,// validate user). - Step markers — planning artefacts (
// Step 1: fetch users,// now we will…,// AI thought: …). - Task / PR / caller references (
// added for ticket X,// used by Y) — that context belongs in the commit message. - Commented-out code — git keeps the history.
- Decorative banners (
// ===== HELPERS =====) when nothing else in the file uses them. - Apologies (
// hacky but works) — either fix the code or open a tracked issue and link it. - Untracked
TODO/FIXME— pair every marker with an owner or an issue, or resolve it now.