No Comments

Review changed code for comments that narrate implementation, preserve dead history, or claim unenforced invariants, then fix only accepted findings. Use for $no-comments before code review.

Vaibtan Updated

File contents

No comments

Scope the review to changed files unless the user names a broader surface.

  1. Run a read-only reviewer, preferably with the fast profile, over comments in scope. It reports file and line, the comment's claim, whether code or a test already expresses it, and one disposition: remove, rewrite as the non-obvious reason, encode in structure, or keep.
  2. Verify every finding against the surrounding code and callers. Reject advice that removes required API documentation, licensing, safety justification, protocol detail, or a real tradeoff.
  3. Apply the smallest accepted edit. A claimed invariant that matters should move into a type, assertion, lint, test, or API shape when practical.
  4. Run the relevant formatter, typecheck, lint, or focused test when the comment change affects syntax or generated documentation.

Comments should explain a reason the code cannot express. They should not narrate phases, restate names, preserve deleted approaches, or compensate for confusing structure.

Vaibtan/pstack-skills-codex-port/tree/main/plugins/pstack/skills/no-comments commit f04d6e0fc1

Frequently asked questions

npx skillmds@latest add vaibtan/no-comments