Skip to main content
skillsmp

Menú

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.

Ir a la instalaciónRevisar archivos

Datos de origen

Repositorio
projectcalico/calico
Última actividad en el origen
3 de septiembre de 2026 a las 01:31
Idioma detectado de SKILL.md
inglés
Estrellas
7388
Forks
1617

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Revisa los archivos de origen

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

Mostrando SKILL.md

SKILL.md
Instrucciones de origen · Vista previa de solo lectura
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`.
Ver en GitHub
Volver a la búsquedaVolver a la instalación