// 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.
Write or review Kueue PR release notes. Use when a user asks to draft, refine, validate, or combine release notes for a Kueue pull request, especially when deciding whether the note should be framed as a bugfix, feature, observability improvement, or breaking change.
Review that new CRD fields have complete godoc comments with enum value descriptions.
Review that paired operations and fields that always appear together are encapsulated in a helper or nested struct.
Review that local variables with unnecessarily wide scope are extracted into helper functions.
Review that new feature-gated behavior has explicit gate checks on all reachable code paths.
Review that update/mutation logic has integration test coverage in test/integration/.
| name | algorithm-comments |
| description | 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. |
| license | Apache-2.0 |
| metadata | {"copyright":"The Kubernetes Authors"} |
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.
