Report · marked 25 Aug 2026
ZuodaoTech/everyone-can-use-english
An agent will struggle here, mostly for fixable reasons.
TypeScript · 36,752 stars · 3,510 files · branch main
42
/100
C
Instructions
2/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
8/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and test command is discoverable.Context economy
11/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
5/10How quickly anything new can orient itself. Losing marks on written documentation and repository description.
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 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/14 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 (start:enjoy, enjoy:add, enjoy:remove, enjoy:dev, enjoy:start, enjoy:test…)
–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 >=20.0.0
–Reproducible environment
n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 8/25 D
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✗Tests exist
4/8
2 test files against 489 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. enjoy/e2e/main.spec.ts, enjoy/e2e/renderer.spec.ts
✗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
11 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
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 11/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 67 patterns.
✗File sizes fit in context
0/6
1 source file is 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-4.6.0.cjs — 2700KB
✗Repository weight
2/5
About 278MB 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 人人都能用英语 ## Setup ``` yarn install ``` ## Commands ``` yarn start:enjoy yarn enjoy:add yarn enjoy:remove yarn enjoy:dev yarn enjoy:start yarn enjoy:test yarn enjoy:test:main yarn enjoy:test:renderer ``` ## Layout - `enjoy/` 459 source files - `1000h-portal/` 17 source files - `1000-hours/` 11 source files - `entry/` 1 source file ## Conventions - Tests live alongside the code they cover, following `enjoy/e2e/main.spec.ts`. - CI defines what passing means. See `.github/workflows/build-enjoy-app-linux.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `.yarn/releases/yarn-4.6.0.cjs` is 2700KB. 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/ZuodaoTech/everyone-can-use-english.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/ZuodaoTech/everyone-can-use-english)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.