Report · marked 25 Aug 2026

go-gorm/gorm

An agent can work here, but it will waste turns finding its footing.

Go · 39,926 stars · 185 files · branch master

66 /100 B

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 8/14Whether an agent can install the project and get it running without a human. Losing marks on discoverable commands.Verification loop 22/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Full marks.Context economy 20/20Whether the repo fits in a context window, or fights it. Full marks.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

Agent instruction file

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

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.

The full marking

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

Instructions 3/27 F

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

✗Agent instruction file 0/12

None found. Every agent that opens this repo starts from zero.

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules

✗Instruction quality 0/12

Nothing to judge, since there are no instructions.

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

✓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 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

101 test files against 163 source files.

e.g. callbacks/create_test.go, callbacks/helper_test.go, clause/benchmarks_test.go

✓Test command is discoverable 7/7

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

✓Continuous integration 4/4

7 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 7 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 4.8MB 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 go-gorm/gorm

# AGENTS.md

The fantastic ORM library for Golang, aims to be developer friendly

## Setup

```
go mod download
```

## Commands

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

## Layout

- `tests/`     57 source files
- `clause/`    36 source files
- `schema/`    21 source files
- `callbacks/` 15 source files
- `utils/`     7 source files
- `logger/`    5 source files

## Conventions

- Tests live alongside the code they cover, following `callbacks/create_test.go`.
- CI defines what passing means. See `.github/workflows/create-release.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/go-gorm/gorm.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/go-gorm/gorm.svg)](https://agentreadme.com/go-gorm/gorm)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 85 A golang/go 31 D kubernetes/kubernetes 72 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