Report · marked 25 Aug 2026

dejan23/agentreadme

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

HTML · 0 stars · 926 files · branch main

98 /100 A+

Instructions 27/27Whether the repo tells an agent how to behave before it starts guessing. Full marks.Setup 20/20Whether an agent can install the project and get it running without a human. Full marks.Verification loop 25/25Whether 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

Written documentation

Prose that explains why the architecture is the way it is saves an agent from re-deriving it wrong.

The full marking

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

Instructions 27/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 12/12

Specific enough that an agent can act on it.

3,235 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 20/20 A+

Whether an agent can install the project and get it running without a human.

✓Deterministic install 6/6

bun.lock pins the dependency tree.

Found bun.lock

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (dev, deploy, typecheck, test, lint, format)

scripts/ directory

✓Environment config 4/4

.dev.vars.example documents what the app needs to run.

✓Pinned runtime version 2/2

The language runtime version is pinned.

Found .nvmrc

✓Reproducible environment 2/2

.devcontainer/devcontainer.json gives a known-good environment.

Verification loop 25/25 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

6 test files against 33 source files.

e.g. src/__tests__/parse.test.ts, src/grade/__tests__/fixture.ts, src/grade/__tests__/rules.test.ts

✓Test command is discoverable 7/7

An agent can find and run `npm run test`.

✓Continuous integration 4/4

2 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

biome.json encodes the house style.

✓Static type checking 3/3

Strict type checking is on, which catches a whole class of agent mistakes before they run.

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 10 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 17.5MB 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 dejan23/agentreadme

# AGENTS.md

Grades any public GitHub repo on how well AI coding agents can work in it

## Setup

```
bun install
```

## Commands

```
bun dev         # run locally
bun test        # run the test suite, must pass before any commit
bun typecheck   # type check without emitting
bun lint        # lint
bun format      # format
bun deploy
```

## Layout

- `src/`        27 source files
- `scripts/`    4 source files
- `migrations/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `src/__tests__/parse.test.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Copy `.dev.vars.example` before running anything that needs configuration.

---

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/dejan23/agentreadme.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/dejan23/agentreadme.svg)](https://agentreadme.com/dejan23/agentreadme)

Other HTML repositories, marked

f/prompts.chat 85 A docker/awesome-compose 38 D QSCTech/zju-icicles 26 F PKUanonym/REKCARC-TSC-UHT 30 D

All HTML 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