agentreadme

Report · marked 26 Aug 2026

h5bp/html5-boilerplate

Solid foundations, held back in a few specific places.

JavaScript · 57,603 stars · 80 files · branch main

72 /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 14/14Whether an agent can install the project and get it running without a human. Full marks.Verification loop 22/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.Context economy 20/20Whether the repo fits in a context window, or fights it. Full marks.Navigability 10/10How quickly anything new can orient itself. Full marks.

Higher is better. Accent marks what is costing you most.

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
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 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 14/14 A+

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 (build, prettier, test, lint)
–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.
package.json engines.node >=22
–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
2 test files against 12 source files.
e.g. test/file_content.mjs, test/file_existence.mjs
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
8 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
eslint.config.mjs 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 6 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 22.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 h5bp/html5-boilerplate 
# AGENTS.md

A professional front-end template for building fast, robust, and adaptable web apps or sites.

## Setup

```
npm ci
```

## Commands

```
npm run build      # produce a build
npm run test       # run the test suite, must pass before any commit
npm run lint       # lint
npm run prettier
```

## Layout

- `dist/` 4 source files
- `src/`  4 source files
- `test/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `test/file_content.mjs`.
- CI defines what passing means. See `.github/workflows/build-dist.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.

---

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/h5bp/html5-boilerplate.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 72 out of 100

[![agent ready](https://agentreadme.com/badge/h5bp/html5-boilerplate.svg)](https://agentreadme.com/h5bp/html5-boilerplate)

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 78 A-

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