Report · marked 26 Aug 2026
slab/quill
An agent can work here, but it will waste turns finding its footing.
TypeScript · 47,317 stars · 377 files · branch main
56
/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
12/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.Verification loop
14/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on test command is discoverable and lint and format rules.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
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
Test command is discoverable
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
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 12/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 (build, build:quill, build:website, start, start:quill, start:website…)
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
0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
✗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 14/25 B-
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
56 test files against 164 source files.
e.g. .github/workflows/_test.yml, packages/quill/test/e2e/__dev_server__/index.html, packages/quill/test/e2e/__dev_server__/webpack.config.cjs
✗Test command is discoverable
0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
✓Continuous integration
4/4
6 GitHub Actions workflows define what "passing" means.
✗Lint and format rules
0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
✗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 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 9 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 18.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 Quill is a modern WYSIWYG editor built for compatibility and extensibility ## Setup ``` npm ci ``` ## Commands ``` npm run start # run the app npm run build # produce a build npm run lint # lint npm run build:quill npm run build:website npm run start:quill npm run start:website ``` ## Layout - `packages/` 161 source files - `scripts/` 3 source files ## Conventions - Tests live alongside the code they cover, following `.github/workflows/_test.yml`. - 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/_test.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/slab/quill.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/slab/quill)Other TypeScript repositories, marked
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.