القائمة
Review a diff for comment hygiene — over-commenting, what-not-why narration, inaccurate comments, and missing TODOs on compatibility shims.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
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 | comments |
| description | Review a diff for comment hygiene — over-commenting, what-not-why narration, inaccurate comments, and missing TODOs on compatibility shims. |
| license | Apache-2.0 |
| metadata | {"copyright":"The Kubernetes Authors"} |
Use this when reviewing a diff for comment hygiene: too many, too few in the wrong places, or — worst — comments that lie about what the code does.
Each rule in this domain is its own sub-skill. Scan the diff for violations of every rule below.
| Rule | Triggers on |
|---|---|
| over-commenting | comments that explain what self-documenting code already says |
| wrong-kind-of-comment | comments describing what instead of why |
| inaccurate-comments | comments or docstrings that no longer match the code |
| missing-deferred-removal-markers | compatibility shim kept without a deferred-removal comment |
| comment-typos | typos and obvious errors in comment text |
@./over-commenting/SKILL.md @./wrong-kind-of-comment/SKILL.md @./inaccurate-comments/SKILL.md @./missing-deferred-removal-markers/SKILL.md @./comment-typos/SKILL.md
Cite the exact file and line, describe the problem, and classify severity (high / medium / low). Inaccurate comments that will mislead a future maintainer, and missing deferred-removal markers on compatibility shims, are high. Over-commenting and what-not-why narration are typically low. Full marks are warranted when comments are absent or limited to explaining the non-obvious why — do not invent findings.
Return two sections:
A bullet list, one per violation, in this format:
- <High/Medium/Low> | <Finding Title>: <one-sentence explanation grounded in the diff>
One recommendation per finding above, numbered sequentially within this skill. Each recommendation MUST contain all four sections below.
### Recommendation N: <short title>
**Problem**: Describe the specific issue in the diff.
**Reason**: Explain why this is a problem — what goes wrong or degrades over time.
**Solution**: Give a concrete, actionable fix. Where possible, show a before/after code snippet.
**Locations**: List every place this issue occurs, one per line, in `filepath:line` form.