OpenParable
Skip to content
← Back to skills

API Field Comments

Testing & Quality
api-field-comments

API Field 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 new CRD fields have complete godoc comments with enum value descriptions.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/kubernetes-sigs/kueue/blob/HEAD/cmd/experimental/skills/reviewer/api-field-comments/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/api-field-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: New API Fields Need Complete Comments

Flag: A new CRD field in apis/kueue/ is added with no godoc comment, a one-word comment, or a comment that references modes or values not yet implemented in this PR.

Ask:

  • Every new field needs a comment explaining its purpose and effect.
  • Enum-like string fields must explicitly list all valid values and their semantics: "Possible values are: X (does …), Y (does …)."
  • Don't mention unsupported or planned-but-not-yet-implemented values — iterate the comment as values are added in future PRs to avoid misleading users about what the API currently supports.