Skip to content

Commit 2d781f4

Browse files
committed
docs: add AGENTS.md with guidelines for AI coding agents
1 parent c389e1f commit 2d781f4

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Agent Guidelines
2+
3+
## Project Overview
4+
5+
Kubernetes operator (controller-runtime) for managing middleware updates for serverless functions deployed with the `func` CLI. Written in Go, uses Ginkgo/Gomega for tests.
6+
7+
## Key Commands
8+
9+
- `make test` - unit tests
10+
- `make test-e2e` - e2e tests (requires Kind cluster with Gitea)
11+
- `make lint` - run golangci-lint
12+
- `gofmt` and `goimports` - format Go files after changes
13+
14+
## Project Structure
15+
16+
- `api/v1alpha1/` - Function CRD types
17+
- `internal/` - controller and business logic
18+
- `test/e2e/` - e2e tests using in-cluster Gitea
19+
- `test/utils/` - e2e test helpers (RepositoryProvider, func CLI wrappers)
20+
- `hack/` - cluster setup scripts
21+
- `config/` - Kustomize manifests
22+
23+
## Important Documentation
24+
25+
Read these files to understand the project setup, conventions, and development workflow:
26+
27+
- `README.md` - user-facing usage, API reference table, installation
28+
- `CONTRIBUTING.md` - development setup, workflow, coding conventions
29+
- `docs/development/` - developer guides (e.g. Gitea integration, test patterns)
30+
31+
After implementing a feature or making significant changes, check whether these docs need updating. The API reference table in README.md must stay in sync with `api/v1alpha1/function_types.go`.

0 commit comments

Comments
 (0)