agentreadme

Report · marked 10 Oct 2026

docker/compose

Ready for an agent to work in without hand-holding.

Go · 38,345 stars · 891 files · branch main

Fix these first

01
Environment config
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
02
Instruction quality
Worth fixing: has no code blocks.
03
README as an entry point
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.

The full marking

Every deduction below names the file or setting it came from.

Instructions 24/27 A

Whether the repo tells an agent how to behave before it starts guessing.

✓Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
Also found: CLAUDE.md
✗Instruction quality 10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
3,082 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
✗README as an entry point 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 16/20 A-

Whether an agent can install the project and get it running without a human.

✓Deterministic install 6/6
go.sum pins the dependency tree.
Found go.sum
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
✗Environment config 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
✓Pinned runtime version 2/2
The language runtime version is pinned.
go.mod declares a Go version
✓Reproducible environment 2/2
dockerfile gives a known-good environment.
Verification loop 22/22 A+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

✓Tests exist 8/8
151 test files against 365 source files.
e.g. cmd/cmdtrace/cmd_span_test.go, cmd/compatibility/convert_test.go, cmd/compose/bridge_test.go
✓Test command is discoverable 7/7
An agent can find and run `make test`.
✓Continuous integration 4/4
10 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
.golangci.yml encodes the house style.
–Static type checking n/a
Not applicable — the Go compiler type checks every build.
Context economy 20/20 A+

Whether the repo fits in a context window, or fights it.

✓No committed build output 6/6
No generated directories committed.
✓.gitignore hygiene 3/3
.gitignore covers 6 patterns.
✓File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
✓Repository weight 5/5
About 29.3MB checked out, which is comfortable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for docker/compose
# AGENTS.md

Define and run multi-container applications with Docker

## Setup

```
go mod download
```

## Commands

```
make build                   # produce a build
make binary
make binary-with-coverage
make install
make e2e-compose
make build-and-e2e-compose
```

## Layout

- `pkg/`      229 source files
- `cmd/`      92 source files
- `internal/` 37 source files
- `docs/`     5 source files
- `relay/`    2 source files

## Conventions

- Tests live alongside the code they cover, following `cmd/cmdtrace/cmd_span_test.go`.
- CI defines what passing means. See `.github/workflows/ai-disclosure-gate.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/docker/compose.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Go AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 93 out of 100

[![agent ready](https://agentreadme.com/badge/docker/compose.svg)](https://agentreadme.com/docker/compose)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 88 A golang/go 31 D kubernetes/kubernetes 74 B+ microsoft/TypeScript 82 A- JuliusBrussee/caveman 81 A-

All Go repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in