AGENTS.md

1# Project: Docker Compose
2 
3## Build & Test
4 
5- Build: `make build`
6- Test all: `make test`
7- Test unit: `go test ./pkg/...`
8- Test single: `go test ./pkg/compose/ -run TestFunctionName`
9- E2E tests: `go test -tags e2e ./pkg/e2e/ -run TestName`
10 
11## Lint
12 
13- Linter: golangci-lint v2 (config in `.golangci.yml`)
14- Run: `golangci-lint run --build-tags "e2e" ./...`
15- **After modifying any Go code, ALWAYS run the linter and fix all reported issues before considering the task complete.**
16- Lint is also run via Docker: `docker buildx bake lint` (uses version pinned in `Dockerfile`)
17 
18## Code Style
19 
20- Formatting is enforced by golangci-lint (gofumpt + gci)
21- Import order: stdlib, third-party, local module (enforced by gci)
22- Max line length: 200 chars
23- Max cyclomatic complexity: 16
24- No `io/ioutil`, `github.com/pkg/errors`, `gopkg.in/yaml.v2`, `golang.org/x/exp/maps`, `golang.org/x/exp/slices`
25- Use `github.com/containerd/errdefs` instead of `github.com/docker/docker/errdefs`
26- In tests: use `t.Context()` instead of `context.Background()` or `context.TODO()`
27- Prefer `fmt.Fprintf` over `WriteString(fmt.Sprintf(...))`
28 
29## Git
30 
31- **All commits MUST be signed off (DCO)**. Always pass `--signoff` (`-s`) to `git commit` and `git commit --amend`.
32 
33## Issue and PR Guidelines
34 
35- Never create an issue or pull request without the user's explicit instruction.
36- If a user asks you to create a pull request on their behalf, add a file named
37  `AI_AGENT_DISCLOSURE.md` to the change containing the text below followed by
38  the current date (`YYYY-MM-DD`). If the file is already present in the
39  repository, update its date to the current date so the disclosure is always
40  part of the change:
41 
42  > *"This contribution was prepared by an AI agent acting on a human's behalf.
43  > The human submitter may not have independently reviewed or tested the change."*
44 
45- If a user asks you to create an issue on their behalf, prepend the following
46  line to the issue body:
47 
48  > *"This issue was filed by an AI agent on a human's behalf. The human
49  > submitter may not have independently verified the report."*
50