Report · marked 27 Aug 2026

zeromicro/go-zero

Solid foundations, held back in a few specific places.

Go · 33,280 stars · 1,375 files · branch master

82 /100 A-

Instructions 23/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file.Setup 8/14Whether an agent can install the project and get it running without a human. Losing marks on discoverable commands.Verification loop 19/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy 18/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.Navigability 8/10How quickly anything new can orient itself. Losing marks on written documentation.

Higher is better. Accent marks what is costing you most.

Fix these first

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.

Agent instruction file

Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping Copilot instructions alongside it costs nothing.

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 23/27 A

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

✗Agent instruction file 8/12

Copilot instructions is present, but not the vendor-neutral AGENTS.md.

Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping Copilot instructions alongside it costs nothing.

✓Instruction quality 12/12

Specific enough that an agent can act on it.

14,585 characters, a workable length

names the actual commands to run

uses headings, so an agent can skim it

includes copyable code blocks

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 8/14 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 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 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

455 test files against 1062 source files.

e.g. core/bloom/bloom_test.go, core/breaker/breaker_test.go, core/breaker/breakers_test.go

✓Test command is discoverable 7/7

An agent can find and run `go test ./...`.

✓Continuous integration 4/4

6 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 18/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 19 patterns.

✗File sizes fit in context 4/6

1 source file is 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.

core/mapping/unmarshaler_test.go — 134KB

✓Repository weight 5/5

About 33.2MB 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 zeromicro/go-zero

# AGENTS.md

A cloud-native Go microservices framework with cli tool for productivity.

## Setup

```
go mod download
```

## Commands

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

## Layout

- `core/`     474 source files
- `tools/`    393 source files
- `rest/`     83 source files
- `zrpc/`     80 source files
- `gateway/`  13 source files
- `internal/` 11 source files

## Conventions

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

## Gotchas

- `core/mapping/unmarshaler_test.go` is 134KB. 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/zeromicro/go-zero.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](https://agentreadme.com/badge/zeromicro/go-zero.svg)](https://agentreadme.com/zeromicro/go-zero)

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- fatedier/frp 96 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