# 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.

- Skill name: `api-field-comments`
- Category: [Testing & Quality](https://www.openparable.com/skill/testing-quality/1)
- Source: https://github.com/kubernetes-sigs/kueue/blob/HEAD/cmd/experimental/skills/reviewer/api-field-comments/SKILL.md
- Repository: kubernetes-sigs/kueue (2,719 GitHub stars when collected)

## SKILL.md

# 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.

---

Source: https://www.openparable.com/skill/testing-quality/api-field-comments (OpenParable). Cite the canonical URL above.
