diff --git a/AGENTS.md b/AGENTS.md index 871e789..f978215 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -12,12 +12,12 @@ Kubernetes operator (controller-runtime) for managing middleware updates for ser Before committing, test locally following the table below: -| If changed | Target | Description | -|------------|--------|-------------| -| `*.go` files | `make test` | Unit tests | -| Any files | `make lint` | Linting | -| `api/` types | `make manifests generate` | Regenerate CRDs and DeepCopy | -| Significant changes | `make test-e2e` | E2E tests (Kind cluster with Gitea required) | +| If changed | Target | Description | +|----------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `*.go` files | `make test` | Unit tests | +| Any files | `make lint` | Linting | +| `api/` types or interfaces | `make update-codegen` | Regenerate CRDs, DeepCopy, and mock implementations | +| Significant changes | `make test-e2e` | E2E tests (Kind cluster with Gitea required - check the [CONTRIBUTING.md](CONTRIBUTING.md#local-development-cluster), for how to setup a local development cluster and how to build and install the operator) | ## Project Structure diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30756e3..55dbb2e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,10 @@ If you find a bug or have a feature request, please [open an issue](https://gith All CI checks must pass before a pull request can be merged. +### Backporting Changes + +To backport a merged PR to a release branch, comment `/cherry-pick release-X.Y` on the PR. This automatically creates a new PR with the cherry-picked changes against the target branch. + ## Further Reading - [Architecture Overview](docs/architecture.md) — system components, reconciliation flow, CRD lifecycle