Skip to content

Commit 25b745b

Browse files
authored
Update AGENTS.md and CONTRIBUTING.md (#142)
1 parent e68c7f9 commit 25b745b

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Kubernetes operator (controller-runtime) for managing middleware updates for ser
1212

1313
Before committing, test locally following the table below:
1414

15-
| If changed | Target | Description |
16-
|------------|--------|-------------|
17-
| `*.go` files | `make test` | Unit tests |
18-
| Any files | `make lint` | Linting |
19-
| `api/` types | `make manifests generate` | Regenerate CRDs and DeepCopy |
20-
| Significant changes | `make test-e2e` | E2E tests (Kind cluster with Gitea required) |
15+
| If changed | Target | Description |
16+
|----------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
17+
| `*.go` files | `make test` | Unit tests |
18+
| Any files | `make lint` | Linting |
19+
| `api/` types or interfaces | `make update-codegen` | Regenerate CRDs, DeepCopy, and mock implementations |
20+
| 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) |
2121

2222
## Project Structure
2323

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ If you find a bug or have a feature request, please [open an issue](https://gith
1717

1818
All CI checks must pass before a pull request can be merged.
1919

20+
### Backporting Changes
21+
22+
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.
23+
2024
## Further Reading
2125

2226
- [Architecture Overview](docs/architecture.md) — system components, reconciliation flow, CRD lifecycle

0 commit comments

Comments
 (0)