docs(contributing): document controller/envtest/kind dev loop - #193
Merged
Conversation
CONTRIBUTING only said 'go test ./...'. Add the real dev loop: make test, make test-controller (auto-installs envtest), make manifests generate after API changes, kind e2e targets, and make validate as the pre-PR gate. Surface the AI Attribution Guard as a PR checklist item so first-time contributors do not hit it by surprise. Signed-off-by: Shreyansh Sancheti <43677304+shreyanshjain7174@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates contributor docs so new contributors can run the same local loops CI expects. It documents controller envtest, manifest generation, and cluster e2e targets. It also updates the PR checklist to surface the controller test gate and the AI Attribution Guard constraint.
Changes:
- Expanded CONTRIBUTING dev loop to include
make test,make test-controller,make manifests generate, cluster e2e targets, andmake validate. - Added
make test-controllerto the PR checklist for API or reconciler changes. - Added an AI Attribution Guard reminder to the PR checklist.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds prerequisites and a fuller local dev and test loop, including controller envtest and cluster e2e targets. |
| .github/PULL_REQUEST_TEMPLATE.md | Updates the contributor checklist to include controller tests and AI Attribution Guard guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+15
to
+19
| - Go 1.25+ and `make`. | ||
| - Controller tests need nothing extra. `make test-controller` downloads the envtest binaries for you on first run. | ||
| - End-to-end tests need a local cluster. `kind` is the default. | ||
| - Python runtime code under `agents/` needs Python 3. The Makefile builds a venv for you. | ||
|
|
Comment on lines
+25
to
30
| # Fast unit tests (Go + ANF snapshot + Python) | ||
| make test | ||
|
|
||
| # Or just the Go unit tests | ||
| go test ./... | ||
| ``` |
| make validate # fmt-check, lint, controller + Go + ANF + Python tests, helm-lint | ||
| ``` | ||
|
|
||
| If your change touches Python runtime code under `agents/`, run `make test-python` as well. |
| - [ ] `make test-controller` passes (if you changed the API or reconciler) | ||
| - [ ] No private-repo content leaked into OSS core | ||
| - [ ] Commit is signed off (`git commit -s`) | ||
| - [ ] Commits are human-authored. No AI names in `Signed-off-by` or `Co-authored-by` trailers (the AI Attribution Guard rejects Claude, Copilot, Cursor, GPT-*, Codex, etc.) |
Comment on lines
+48
to
+54
| These need a running cluster. `kind` works: | ||
|
|
||
| ```bash | ||
| make test-cluster # apply CRDs and run against the cluster | ||
| make test-smoke # smoke checks, including the demo CLI | ||
| make test-e2e-cluster | ||
| ``` |
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.
CONTRIBUTING only told contributors to run
go test ./.... That misses the controller tests, the envtest setup, and the kind e2e path, so a first-time contributor cannot reproduce CI locally.Changes:
Docs only. No code or behavior change. Every make target referenced was verified to exist in the Makefile.