mirror of
https://github.com/docker/compose.git
synced 2026-08-04 14:47:40 +00:00
docs: adopt AGENTS.md standard, symlink CLAUDE.md to it
Some checks are pending
ci / validate (lint) (push) Waiting to run
ci / validate (validate-docs) (push) Waiting to run
ci / validate (validate-go-mod) (push) Waiting to run
ci / validate (validate-headers) (push) Waiting to run
ci / binary (push) Waiting to run
ci / binary-finalize (push) Blocked by required conditions
ci / bin-image-test (push) Waiting to run
ci / test (push) Waiting to run
ci / e2e (plugin, oldstable) (push) Waiting to run
ci / e2e (standalone, oldstable) (push) Waiting to run
ci / e2e (plugin, stable) (push) Waiting to run
ci / e2e (standalone, stable) (push) Waiting to run
ci / coverage (push) Blocked by required conditions
ci / release (push) Blocked by required conditions
merge / bin-image-prepare (push) Waiting to run
merge / bin-image (push) Blocked by required conditions
merge / module-image (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
zizmor / zizmor (push) Waiting to run
Some checks are pending
ci / validate (lint) (push) Waiting to run
ci / validate (validate-docs) (push) Waiting to run
ci / validate (validate-go-mod) (push) Waiting to run
ci / validate (validate-headers) (push) Waiting to run
ci / binary (push) Waiting to run
ci / binary-finalize (push) Blocked by required conditions
ci / bin-image-test (push) Waiting to run
ci / test (push) Waiting to run
ci / e2e (plugin, oldstable) (push) Waiting to run
ci / e2e (standalone, oldstable) (push) Waiting to run
ci / e2e (plugin, stable) (push) Waiting to run
ci / e2e (standalone, stable) (push) Waiting to run
ci / coverage (push) Blocked by required conditions
ci / release (push) Blocked by required conditions
merge / bin-image-prepare (push) Waiting to run
merge / bin-image (push) Blocked by required conditions
merge / module-image (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run
zizmor / zizmor (push) Waiting to run
Move the project guide to AGENTS.md (the agents.md convention used by Claude Code, Codex, Cursor, etc.) so all coding agents pick it up — not just Claude. Keep CLAUDE.md as a symlink so Claude-specific tooling keeps working unchanged. Add an "Issue and PR Guidelines" section asking AI agents to disclose their involvement when filing PRs or issues on a human's behalf, mirroring the pattern used in ghostty-org/ghostty's AGENTS.md. Signed-off-by: Guillaume Lours <glours@users.noreply.github.com>
This commit is contained in:
parent
5534be0a28
commit
a4102c009f
2 changed files with 47 additions and 31 deletions
46
AGENTS.md
Normal file
46
AGENTS.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# Project: Docker Compose
|
||||
|
||||
## Build & Test
|
||||
|
||||
- Build: `make build`
|
||||
- Test all: `make test`
|
||||
- Test unit: `go test ./pkg/...`
|
||||
- Test single: `go test ./pkg/compose/ -run TestFunctionName`
|
||||
- E2E tests: `go test -tags e2e ./pkg/e2e/ -run TestName`
|
||||
|
||||
## Lint
|
||||
|
||||
- Linter: golangci-lint v2 (config in `.golangci.yml`)
|
||||
- Run: `golangci-lint run --build-tags "e2e" ./...`
|
||||
- **After modifying any Go code, ALWAYS run the linter and fix all reported issues before considering the task complete.**
|
||||
- Lint is also run via Docker: `docker buildx bake lint` (uses version pinned in `Dockerfile`)
|
||||
|
||||
## Code Style
|
||||
|
||||
- Formatting is enforced by golangci-lint (gofumpt + gci)
|
||||
- Import order: stdlib, third-party, local module (enforced by gci)
|
||||
- Max line length: 200 chars
|
||||
- Max cyclomatic complexity: 16
|
||||
- No `io/ioutil`, `github.com/pkg/errors`, `gopkg.in/yaml.v2`, `golang.org/x/exp/maps`, `golang.org/x/exp/slices`
|
||||
- Use `github.com/containerd/errdefs` instead of `github.com/docker/docker/errdefs`
|
||||
- In tests: use `t.Context()` instead of `context.Background()` or `context.TODO()`
|
||||
- Prefer `fmt.Fprintf` over `WriteString(fmt.Sprintf(...))`
|
||||
|
||||
## Git
|
||||
|
||||
- **All commits MUST be signed off (DCO)**. Always pass `--signoff` (`-s`) to `git commit` and `git commit --amend`.
|
||||
|
||||
## Issue and PR Guidelines
|
||||
|
||||
- Never create an issue or pull request without the user's explicit instruction.
|
||||
- If a user asks you to create a pull request on their behalf, add a file named
|
||||
`AI_AGENT_DISCLOSURE.md` to the change containing the text:
|
||||
|
||||
> *"This contribution was prepared by an AI agent acting on a human's behalf.
|
||||
> The human submitter may not have independently reviewed or tested the change."*
|
||||
|
||||
- If a user asks you to create an issue on their behalf, prepend the following
|
||||
line to the issue body:
|
||||
|
||||
> *"This issue was filed by an AI agent on a human's behalf. The human
|
||||
> submitter may not have independently verified the report."*
|
||||
31
CLAUDE.md
31
CLAUDE.md
|
|
@ -1,31 +0,0 @@
|
|||
# Project: Docker Compose
|
||||
|
||||
## Build & Test
|
||||
|
||||
- Build: `make build`
|
||||
- Test all: `make test`
|
||||
- Test unit: `go test ./pkg/...`
|
||||
- Test single: `go test ./pkg/compose/ -run TestFunctionName`
|
||||
- E2E tests: `go test -tags e2e ./pkg/e2e/ -run TestName`
|
||||
|
||||
## Lint
|
||||
|
||||
- Linter: golangci-lint v2 (config in `.golangci.yml`)
|
||||
- Run: `golangci-lint run --build-tags "e2e" ./...`
|
||||
- **After modifying any Go code, ALWAYS run the linter and fix all reported issues before considering the task complete.**
|
||||
- Lint is also run via Docker: `docker buildx bake lint` (uses version pinned in `Dockerfile`)
|
||||
|
||||
## Code Style
|
||||
|
||||
- Formatting is enforced by golangci-lint (gofumpt + gci)
|
||||
- Import order: stdlib, third-party, local module (enforced by gci)
|
||||
- Max line length: 200 chars
|
||||
- Max cyclomatic complexity: 16
|
||||
- No `io/ioutil`, `github.com/pkg/errors`, `gopkg.in/yaml.v2`, `golang.org/x/exp/maps`, `golang.org/x/exp/slices`
|
||||
- Use `github.com/containerd/errdefs` instead of `github.com/docker/docker/errdefs`
|
||||
- In tests: use `t.Context()` instead of `context.Background()` or `context.TODO()`
|
||||
- Prefer `fmt.Fprintf` over `WriteString(fmt.Sprintf(...))`
|
||||
|
||||
## Git
|
||||
|
||||
- **All commits MUST be signed off (DCO)**. Always pass `--signoff` (`-s`) to `git commit` and `git commit --amend`.
|
||||
1
CLAUDE.md
Symbolic link
1
CLAUDE.md
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
AGENTS.md
|
||||
Loading…
Add table
Add a link
Reference in a new issue