docs: add CONTRIBUTING.md#160
Open
kochj23 wants to merge 1 commit into
Open
Conversation
The repo has LICENSE, CHANGELOG, CI, and extensive docs/ but no CONTRIBUTING guide. Document the contributor workflow so the make-based generate / envtest / lint flow and the conventional-commit release rules are discoverable, mirroring the sibling towonel-operator's CONTRIBUTING. Covers: prerequisites (Go 1.26, make); the `make generate` / `make test` (unit + envtest via setup-envtest) / `make lint` (golangci-lint + gofmt) / `make build` workflow; the generated-artifact policy (never hand-edit controller-gen / helm-docs / crd-ref-docs outputs); fake-client vs envtest testing conventions; the Conventional Commits release rules and alpha breaking->minor versioning from .releaserc.json; the PR Validation CI jobs; and the MIT license-header boilerplate for new Go files. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
The repo ships
LICENSE,CHANGELOG.md, CI workflows, and an extensivedocs/tree, but has no
CONTRIBUTING.md— so themake-based generate/test/lint flowand the release conventions aren't discoverable for a new contributor. This adds
one, mirroring the sibling
towonel-operator'sCONTRIBUTING (adapted from its
task-based flow to this repo'smake-based one).What it documents
Everything is drawn from the repo's actual tooling, not boilerplate:
go.mod),make; on-demand tooling viamake tools;golangci-lintas ago tooldependency.make generate/make test/make lint/make build(andmake all), matching theMakefile.controller-gen(CRDs + deepcopy), the chart CRD templates,helm-docs(chart/README.md), andcrd-ref-docs(docs/crd-reference.md), all produced bymake generate.test/envtest/integration suite (kube binaries provisioned bysetup-envtest,KUBEBUILDER_ASSETSexported bymake test, graceful skip when unset).breaking → minorpolicy taken directly from.releaserc.json(feat→minor,fix/refactor→patch,chore(cloudflared)→patch,chore(deps)grouped in notes but non-triggering).make generate/lint/testchecklist and the threepr.ymlvalidation jobs (Lint, Tests, Envtest Suite).hack/boilerplate.go.txtfor new Go files.Tests
Docs-only change — no code paths touched, so the 7 test categories are N/A. Verified links resolve to real in-repo files/anchors (
Makefile,.releaserc.json,.github/workflows/pr.yml,hack/boilerplate.go.txt,README.md#local-development) and that the documentedmaketargets and release rules match the current tooling.🤖 Generated with Claude Code