API Field Comments

Review that new CRD fields have complete godoc comments with enum value descriptions.

kubernetes-sigs Updated

File contents

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.

kubernetes-sigs/kueue/tree/main/cmd/experimental/skills/reviewer/api-field-comments commit fa137b9636

Frequently asked questions

npx skillmds@latest add kubernetes-sigs-kueue/api-field-comments