Find your next open-source project

Search by name, purpose, or keyword — or paste a GitHub repository URL
All skills

writing-code-comments

Decide whether a code comment should exist, and rewrite the ones that stay to explain why.

When to use it

You are about to add a comment to a diff, or reviewing one, and need to tell a useful why from narration, change history, or stale numbers.

For example

You say

Use writing-code-comments on this diff: I added `# increment retry count` above `retries += 1`, `# per PR #1234` on the backoff helper, and `# ~20 min build` on the CI timeout. Clean up the comments.

You get
  • Comments removed or rewritten
  • Kept why-comments list

How it works

  • The default is no comment; a comment must tell a future reader something the code cannot.
  • Perishable numbers are replaced with the durable fact they stood for, unless dated or tied to a code literal.