Skip to content

Add Skill to validate k8s CRDs. #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Julian Gutierrez Oschmann (juli4n) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Skill to validate k8s CRDs. #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .agents/skills/review-crds/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: review-crds
description: Guides the agent to follow Kubernetes API conventions for OSS standards.

@mtaufen Michael Taufen (mtaufen) Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "Reviews CRDs for compliance with Kubernetes API conventions" would be more tool-centric language. Whether this guides the agent depends on if the agent is triggered to open the skill.

---

# Kubernetes API Conventions Skill

## Purpose

@mtaufen Michael Taufen (mtaufen) Jun 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Purpose may be best left to the description in frontmatter as it's somewhat redundant. Since we want a structured response, recommend asking for JSON. We could format the SKILL something like this:

Task

Review any CRDs in Agent Substrate to ensure they follow the conventions in references/api-conventions.md.

Output Format

Your output should be a list of violations conforming to the following JSON format:

[ 
  {
    "location":"",
    "rule": "",
    "fix": ""
  }
]
  • location: file path and line range that violated the rule, formatted like this: path/to/file/under/review:1-10. The path is relative to the repo root.
  • rule: Exact quote of violated rule from references/api-conventions.md. If there is no rule, this should be set to the string OPINION.
  • fix: Your suggestion of how to fix the issue.

Hints

  • Most CRDs are defined in pkg/api/v1alpha1.


This skill ensures that all Custom Resource Definitions (CRDs) generated or modified in Agent Substrate follow the established conventions defined by the Kubernetes community.
Substrate CRDs are defined under pkg/api/v1alpha1.

## Reporting violations

When you report a convention violation, **include a verbatim quote of the rule**, copied exactly from
`references/api-conventions.md`, alongside the offending symbol and a concrete fix.
Grep the reference for the exact wording before writing each finding; do not
paraphrase from memory. If a finding has no verbatim rule (substrate consistency, mechanics, design intent),
mark it *(no verbatim rule)* rather than inventing a quote. The verbatim text lets reviewers cross-validate
findings against the source.

## References
- [Kubernetes API Conventions](references/api-conventions.md)
Loading
Loading