-
Notifications
You must be signed in to change notification settings - Fork 5.8k
docs: adopt AGENTS.md standard, symlink CLAUDE.md to it #13871
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.
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
Open
glours
wants to merge
1
commit into
docker:main
Choose a base branch
from
glours:docs/agents-md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
|
Comment on lines
+42
to
+43
|
||
|
|
||
| > *"This issue was filed by an AI agent on a human's behalf. The human | ||
| > submitter may not have independently verified the report."* | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| AGENTS.md |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.