+- **Comments**: comments that restate what the code does, justify the decision ("intentionally", "for safety"), address the reviewer, narrate rejected alternatives, or reference issues/PRs/review threads. Comments are evergreen and for future readers of the code; almost all of these should be deleted (or the code made clearer instead). Numbered comments are always wrong. Tool directives are exempt: `eslint-disable`, `oxlint-disable`, `@ts-expect-error`, `@ts-ignore`, `prettier-ignore`, `v8 ignore`, and similar are machine instructions, and the short reason attached to one is required context, not justification -- never flag them under this category.
0 commit comments