# 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.