Add operator-api-standards Claude Code skill#4942
Open
Brian-McM wants to merge 1 commit into
Open
Conversation
Adds a project-scoped skill that guides contributors on conventions and dos/don'ts when adding or changing CRD types under api/v1. Distills the rationale in docs/principles.md and docs/dev_guidelines.md into concrete, checkable rules plus the repo's kubebuilder/Go coding conventions, and documents the required post-change workflow (gen-files, convert, dirty-check). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
aa60d1a to
ec739b0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a project-scoped Claude Code skill that guides contributors on conventions and dos/don'ts when adding or changing CRD types under
api/v1/.The skill distills the rationale already captured in
docs/principles.md("API Design", "Respect User Input", "Resource Ownership") anddocs/dev_guidelines.md("API code") into concrete, checkable rules, and pairs them with the repo's actual kubebuilder/Go coding conventions observed across the existing*_types.gofiles:omitempty++optionalfor optional fields, theEnabled/Disabledenum idiom over*bool, CELMaxLength/MaxItemsbounds and the single-quote gotcha, the top-level Kind marker block +List+init()registration, copyright header, shared-type reuse.whisker_deployment_types.go.make gen-files, cluster-scope check,convertpackage,pkg/common/validation,make dirty-check.It auto-triggers whenever a contributor (using Claude Code) edits files under
api/v1/, so the guidance surfaces at the moment it's relevant.For PR author
For PR reviewers
This is purely additive (a new
.claude/skills/markdown file); no operator behavior changes. Feedback welcome on the conventions themselves — whether anything is inaccurate, missing, or too prescriptive.🤖 Generated with Claude Code