operator-api-standards

Standards, conventions, and dos/don'ts for adding or changing CRD types in the operator API (`operator/api/v1`). Use this skill whenever editing or creating files under `operator/api/v1/` (any *_types.go), adding/removing/renaming a CRD field, introducing a new Kind/CRD, adding kubebuilder validation or defaulting markers, or designing an overrides/configuration field. Trigger even if the user doesn't mention "standards" — any change to operator CRD types should follow these conventions.

Jump to install Review files

Repository: projectcalico/calico
Last source activity: September 3, 2026 at 01:31
Detected SKILL.md language: English
Stars: 7,394
Forks: 1,621

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/projectcalico/calico/tree/master/.claude/skills/operator-api-standards.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/projectcalico/calico --skill operator-api-standards

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

SKILL.md

Source instructions · Read-only preview

name: operator-api-standards
description: Standards, conventions, and dos/don'ts for adding or changing CRD types in the operator API (`operator/api/v1`). Use this skill whenever editing or creating files under `operator/api/v1/` (any *_types.go), adding/removing/renaming a CRD field, introducing a new Kind/CRD, adding kubebuilder validation or defaulting markers, or designing an overrides/configuration field. Trigger even if the user doesn't mention "standards" — any change to operator CRD types should follow these conventions.

# Operator API Standards When adding or changing CRD types under `operator/api/v1/`: 1. **Read [`operator/docs/api_design.md`](../../../operator/docs/api_design.md)** — the API design principles plus the concrete Go/kubebuilder coding conventions (optional vs required fields, the `Enabled`/`Disabled` enum idiom, validation/CEL markers, the top-level Kind marker block, shared-type reuse, the Deployment override pattern) and the end-of-file **checklist**. Apply all of it, and run the checklist before you finish. 2. **Read [`DESIGN.md`](../../../operator/DESIGN.md)** for related rules ("Respect User Input", "Resource Ownership") when a judgement call isn't settled by `api_design.md`. 3. Follow the post-change workflow in `api_design.md` — `make gen-files`, verify scope didn't flip to `Namespaced`, update `convert` if relevant, and `make dirty-check`.

View on GitHub

Back to search Back to installation

design-doc-edits

Write or review an edit to a DESIGN.md — the altitude to write at, a worked example of an edit that was 34 lines too long, and the criteria for reviewing a design-doc diff. Use when about to add or change prose in any DESIGN.md or design/ sub-design, when reviewing a design-doc diff, or when compressing a design doc that has grown too large.

2026-09-01

operator-versioning

Map between Calico/enterprise versions and tigera/operator release branches, for the releases that predate the operator moving into this repo. Use this skill whenever you need to determine which operator branch corresponds to a Calico or enterprise release (e.g., "which operator branch is Calico v3.30?"), or the reverse (e.g., "what Calico version does release-v1.40 ship?"). Also use this skill whenever cherry-picking to operator release branches, creating cherry-pick PRs targeting release branches, or any task that requires knowing the operator↔Calico version relationship. Trigger even if the user doesn't explicitly ask about versioning — if the task involves targeting an operator release branch by Calico version, use this skill to find the right branch.

2026-09-01

release-branch-cut

Cut a release branch with the `release branch cut` command: create the branch, apply the version-reference edits, tag it, and push. Use this skill when cutting a release branch, when a cut failed partway and needs to resume, or when a version-bearing file has moved and the cut's edits need updating.

2026-08-16

View all from this repository

operator-api-standards

Source facts

Install options

Install with an AI assistant

Review the source files

More from this repository

Install with an AI assistant

More from this repository