agentreadme

Report Β· marked 10 Oct 2026

thedaviddias/Front-End-Checklist

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

MDX Β· 74,422 stars Β· 1,978 files Β· branch main

Fix these first

01
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.
02
README as an entry point
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
03
Static type checking
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

The full marking

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

Instructions 22/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 10/12
Specific enough that an agent can act on it.
Worth fixing: it's 21k characters, which burns context on every single turn.
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
βœ—README as an entry point 0/3
No README. This is the first file anything reads, human or machine.
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
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
βœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (build, dev, email:preview, lint, lint:fix, format…)
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.
Found .nvmrc
–Reproducible environment n/a
Not applicable β€” a library doesn't need a container to be worked on.
Verification loop 22/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
103 test files against 596 source files.
e.g. apps/web/app/(site)/(account)/profile/profile-url-section.test.tsx, apps/web/app/(site)/checklists/[slug]/__tests__/page.test.tsx, apps/web/app/(site)/guides/[slug]/__tests__/page.test.tsx
βœ“Test command is discoverable 7/7
An agent can find and run `npm run test`.
βœ“Continuous integration 4/4
6 GitHub Actions workflows define what "passing" means.
βœ“Lint and format rules 3/3
biome.json encodes the house style.
βœ—Static type checking 0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
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 54 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 9.4MB 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 thedaviddias/Front-End-Checklist
# AGENTS.md

πŸ—‚ The essential checklist for modern web development, for humans and AI agents

## Setup

```
pnpm install
```

## Commands

```
pnpm dev             # run locally
pnpm build           # produce a build
pnpm test            # run the test suite, must pass before any commit
pnpm typecheck       # type check without emitting
pnpm lint            # lint
pnpm format          # format
pnpm email:preview
pnpm lint:fix
```

## Layout

- `apps/`     323 source files
- `packages/` 220 source files
- `scripts/`  50 source files
- `configs/`  1 source file

## Conventions

- Tests live alongside the code they cover, following `apps/web/app/(site)/(account)/profile/profile-url-section.test.tsx`.
- 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.

---

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/thedaviddias/Front-End-Checklist.md

A draft gets the commands right and stops at the things only a maintainer knows. what AGENTS.md is explains the format itself.

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 88 out of 100

[![agent ready](https://agentreadme.com/badge/thedaviddias/Front-End-Checklist.svg)](https://agentreadme.com/thedaviddias/Front-End-Checklist)

Other MDX repositories, marked

twbs/bootstrap 81 A- dair-ai/Prompt-Engineering-Guide 61 B- inkonchain/docs 50 C+

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