Wrong Kind Of Comment

Flag comments that describe *what* the code does instead of *why* it does it.

kubernetes-sigs Updated 3.2k repo stars

File contents

Skill: Wrong Kind of Comment

Wrong kind of comment — comments that describe what the code does instead of why it does it. Useful comments explain non-obvious motivation, hidden constraints, or the theoretical background a reader could not infer from the code itself.

kubernetes-sigs/kueue commit 39b94d046a

Frequently asked questions

npx get-skill add kubernetes-sigs-kueue/wrong-kind-of-comment