agentreadme

Report · marked 26 Aug 2026

gatsbyjs/gatsby

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

JavaScript · 55,943 stars · 7,262 files · branch master

Fix these first

01
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.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
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.

The full marking

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

Instructions 2/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 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 14/18 A-

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

Deterministic install 6/6
yarn.lock pins the dependency tree.
Found yarn.lock
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (bootstrap, check-repo-fields, check-versions, format, format:code, format:other…)
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 >=18.0.0 <26
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 24/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
944 test files against 4135 source files.
e.g. .github/actions/high-priority-prs/src/__tests__/__snapshots__/pr-message.js.snap, .github/actions/high-priority-prs/src/__tests__/__snapshots__/process-data.js.snap, .github/actions/high-priority-prs/src/__tests__/fixtures/data.json
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
1 GitHub Actions workflow define what "passing" means.
Lint and format rules 3/3
.eslintrc.js encodes the house style.
Static type checking 2/3
Type checking is configured, but not in strict mode.
Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.
Context economy 6/20 D

Whether the repo fits in a context window, or fights it.

No committed build output 3/6
Generated output is committed: node_modules/.
Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.
.gitignore hygiene 3/3
.gitignore covers 37 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.
.yarn/releases/yarn-1.21.0.js — 4974KB
integration-tests/gatsby-source-wordpress/docker/seed/backup.sql — 1838KB
Repository weight 0/5
About 1151MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 gatsbyjs/gatsby
# AGENTS.md

React-based framework with performance, scalability, and security built in.

## Setup

```
yarn install
```

## Commands

```
yarn test                # run the test suite, must pass before any commit
yarn typecheck           # type check without emitting
yarn lint                # lint
yarn format              # format
yarn bootstrap
yarn check-repo-fields
yarn check-versions
yarn format:code
```

## Layout

- `packages/`            1893 source files
- `e2e-tests/`           741 source files
- `examples/`            591 source files
- `integration-tests/`   337 source files
- `benchmarks/`          263 source files
- `deprecated-packages/` 194 source files

## Conventions

- Tests live alongside the code they cover, following `.github/actions/high-priority-prs/src/__tests__/__snapshots__/pr-message.js.snap`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/schedule-stale.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `.yarn/releases/yarn-1.21.0.js` is 4974KB. 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/gatsbyjs/gatsby.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 56 out of 100

[![agent ready](https://agentreadme.com/badge/gatsbyjs/gatsby.svg)](https://agentreadme.com/gatsbyjs/gatsby)

Other JavaScript repositories, marked

react/react 71 B+ affaan-m/ECC 90 A trekhleb/javascript-algorithms 69 B Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+ vercel/next.js 77 B+

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