Menu
Flag comments that describe *what* the code does instead of *why* it does it.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Build and manage a kind cluster for Workload-Aware Scheduling (WAS) e2e tests. Use when the user wants to set up, run tests against, or tear down a WAS test cluster built from Kubernetes main.
Flag solutions more elaborate than the problem requires — complexity that exists only because the author reached for a pattern.
Flag identical (or near-identical) blocks across types/adapters/call sites that should live in a shared helper — and newly extracted helpers with only one caller.
Flag code organization that a future maintainer will struggle to follow, modify, or extend.
Flag code put somewhere a reader would not expect to find it — cleanup scattered across callers, validation deep in business logic.
Flag unnecessary indirection, mismatched abstractions, or confusing data flow that obscures what the code is doing.
| name | wrong-kind-of-comment |
| description | Flag comments that describe *what* the code does instead of *why* it does it. |
| license | Apache-2.0 |
| metadata | {"copyright":"The Kubernetes Authors"} |
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.
