Skip to content

Update AGENTS.md and CONTRIBUTING.md #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
creydr merged 2 commits into from
May 12, 2026
+10 −6
Merged

Update AGENTS.md and CONTRIBUTING.md #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ef65a5
Update AGENTS.md
creydr May 12, 2026
66a3eff
Add information how to backport changes
creydr May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading