Algorithm Comments
Testing & Qualityalgorithm-commentsAlgorithm Comments is an Agent Skill for testing & quality published in the kubernetes-sigs/kueue repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Review that algorithm comments match the implementation. Use when a comment describes a formula or algorithm and you want to verify it matches what the code actually does.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/kubernetes-sigs/kueue/blob/HEAD/cmd/experimental/skills/reviewer/algorithm-comments/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/algorithm-comments, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Skill: Algorithm Comments Must Match the Implementation
Flag: A comment describing a mathematical formula or algorithm that doesn't match what the code actually does (e.g., comment says "ceiling" but code uses rounding via int(x + 0.5)).
Ask: Correct the comment to match the implementation, or fix the implementation to match the comment. A mismatch is a latent correctness bug — future maintainers will trust the comment over the code.