agentreadme

Report Β· marked 26 Aug 2026

ant-design/ant-design-pro

Solid foundations, held back in a few specific places.

TypeScript Β· 38,703 stars Β· 335 files Β· branch master

Fix these first

01
Instruction quality
Worth fixing: it's under 200 characters, which is closer to a placeholder than instructions; it never states a build, test, or run command; has no headings to structure it; has no code blocks.
02
File sizes fit in context
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.
03
Environment config
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.

The full marking

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

Instructions 15/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 0/12
Present but too thin to change an agent's behavior.
Worth fixing: it's under 200 characters, which is closer to a placeholder than instructions; it never states a build, test, or run command; has no headings to structure it; has no code blocks.
βœ“README as an entry point 3/3
README has a clear getting-started section.
Setup 14/20 B+

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

βœ“Deterministic install 6/6
package-lock.json pins the dependency tree.
Found package-lock.json
βœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (analyze, build, deploy, dev, i18n-remove, lint…)
scripts/ directory
βœ—Environment config 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
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.
package.json engines.node >=22.0.0
βœ—Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 21/25 A-

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

βœ—Tests exist 4/8
13 test files against 279 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. src/access.test.ts, src/app.test.tsx, src/pages/account/settings/components/base.test.tsx
βœ“Test command is discoverable 7/7
An agent can find and run `npm run test`.
βœ“Continuous integration 4/4
9 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 14/20 B+

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 29 patterns.
βœ—File sizes fit in context 0/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.
src/pages/dashboard/monitor/mock/map-grid.ts β€” 908KB
src/pages/dashboard/monitor/mock/map-geo.ts β€” 209KB
βœ“Repository weight 5/5
About 42.9MB 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 ant-design/ant-design-pro
# AGENTS.md

πŸ‘¨πŸ»β€πŸ’»πŸ‘©πŸ»β€πŸ’» Use Ant Design like a Pro!

## Setup

```
npm ci
```

## Commands

```
npm run dev           # run locally
npm run start         # run the app
npm run build         # produce a build
npm run test          # run the test suite, must pass before any commit
npm run lint          # lint
npm run analyze
npm run deploy
npm run i18n-remove
```

## Layout

- `src/`               239 source files
- `cloudflare-worker/` 17 source files
- `config/`            6 source files
- `mock/`              6 source files
- `tests/`             3 source files
- `scripts/`           2 source files

## Conventions

- Tests live alongside the code they cover, following `src/access.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/antd-cli.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/pages/dashboard/monitor/mock/map-grid.ts` is 908KB. 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/ant-design/ant-design-pro.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 73 out of 100

[![agent ready](https://agentreadme.com/badge/ant-design/ant-design-pro.svg)](https://agentreadme.com/ant-design/ant-design-pro)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 A-

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