agentreadme

Report · marked 10 Oct 2026

gohugoio/hugo

Solid foundations, held back in a few specific places.

Go · 90,074 stars · 2,601 files · branch master

Fix these first

01
Instruction quality
Worth fixing: it never states a build, test, or run command; has no headings to structure it; has no code blocks.
02
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
03
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

The full marking

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

Instructions 19/27 B+

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 4/12
Present but too thin to change an agent's behavior.
Worth fixing: it never states a build, test, or run command; has no headings to structure it; has no code blocks.
1,712 characters, a workable length
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 12/20 B-

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 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
✗Environment config 2/4
Env vars are mentioned in the README but there's no example file to copy.
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 19/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
394 test files against 954 source files.
e.g. bufferpool/bufpool_test.go, cache/dynacache/dynacache_test.go, cache/filecache/filecache_config_test.go
✓Test command is discoverable 7/7
An agent can find and run `go test ./...`.
✓Continuous integration 4/4
3 GitHub Actions workflows define what "passing" means.
✗Lint and format rules 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
–Static type checking n/a
Not applicable — the Go compiler type checks every build.
Context economy 17/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 9 patterns.
✗File sizes fit in context 4/6
2 source files are over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
internal/warpc/js/renderkatex.bundle.js — 295KB
livereload/livereload.js — 152KB
✗Repository weight 4/5
About 146.6MB 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 gohugoio/hugo
# AGENTS.md

The world’s fastest framework for building websites.

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Layout

- `tpl/`       213 source files
- `resources/` 152 source files
- `hugolib/`   122 source files
- `common/`    115 source files
- `markup/`    58 source files
- `internal/`  32 source files

## Conventions

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

## Gotchas

- `internal/warpc/js/renderkatex.bundle.js` is 295KB. It will not fit comfortably in context, so read it in parts.

---

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/gohugoio/hugo.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 78 out of 100

[![agent ready](https://agentreadme.com/badge/gohugoio/hugo.svg)](https://agentreadme.com/gohugoio/hugo)

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