agentreadme

Report · marked 25 Aug 2026

veggiemonk/awesome-docker

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

36,712 stars · 56 files · branch master

Fix these first

01
Instruction quality
Worth fixing: has no code blocks.
02
Written documentation
Prose that explains why the architecture is the way it is saves an agent from re-deriving it wrong.
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.
2,764 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 14/14 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
scripts/ directory
Environment config n/a
Not applicable — this reads as a library, with no environment to configure.
Pinned runtime version 2/2
The language runtime version is pinned.
go.mod declares a Go version
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
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
10 test files against 27 source files.
e.g. internal/builder/builder_test.go, internal/cache/cache_test.go, internal/checker/github_test.go
Test command is discoverable 7/7
An agent can find and run `make test`.
Continuous integration 4/4
4 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 15 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 14.9MB 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 veggiemonk/awesome-docker
# AGENTS.md

:whale: A curated list of Docker resources and projects

## Setup

```
go mod download
```

## Commands

```
make help
make build     # produce a build
make rebuild
make clean
make fmt
make test      # run the test suite, must pass before any commit
```

## Layout

- `internal/` 25 source files
- `cmd/`      1 source file
- `scripts/`  1 source file

## Conventions

- Tests live alongside the code they cover, following `internal/builder/builder_test.go`.
- CI defines what passing means. See `.github/workflows/broken_links.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/veggiemonk/awesome-docker.md

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 95 out of 100

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

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