Report · marked 26 Aug 2026
laurent22/joplin
Solid foundations, held back in a few specific places.
TypeScript · 56,110 stars · 8,539 files · branch dev
70
/100
B+
Instructions
21/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
14/18Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop
24/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
6/20Whether the repo fits in a context window, or fights it. Losing marks on .gitignore hygiene and file sizes fit in context.Navigability
5/10How quickly anything new can orient itself. Losing marks on written documentation and license.
Higher is better. Accent marks what is costing you most.
Fix these first
01
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.
02
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.
03
Repository weight
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.
The full marking
Every deduction below names the file or setting it came from.
Instructions 21/27 A-
Whether the repo tells an agent how to behave before it starts guessing.
✗Agent instruction file
9/12
CLAUDE.md is present, but not the vendor-neutral AGENTS.md.
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
✗Instruction quality
10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
2,177 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
✗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 (buildApiDoc, buildScriptIndexes, buildParallel, buildPluginDoc, buildSequential, buildServerDocker…)
✗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 >=22.12
–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
2247 test files against 3882 source files.
e.g. packages/app-cli/app/cli-integration-tests.test.ts, packages/app-cli/app/command-cat.test.ts, packages/app-cli/app/command-done.test.ts
✓Test command is discoverable
7/7
An agent can find and run `npm run test`.
✓Continuous integration
4/4
12 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
eslint.config.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
6/6
No generated directories committed.
✗.gitignore hygiene
0/3
No .gitignore.
Start from a standard template for your stack. It prevents the previous problem before it happens.
✗File sizes fit in context
0/6
4 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-4.16.0.cjs — 2943KB
packages/lib/welcomeAssets.js — 637KB
packages/renderer/assets/abc/abcjs-basic-min.js — 492KB
✗Repository weight
0/5
About 654MB 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 Joplin - the privacy-focused note taking app with sync capabilities for Windows, macOS, Linux, Android and iOS. ## Setup ``` yarn install ``` ## Commands ``` yarn test # run the test suite, must pass before any commit yarn buildApiDoc yarn buildScriptIndexes yarn buildParallel yarn buildPluginDoc yarn buildSequential yarn buildServerDocker yarn buildSettingJsonSchema ``` ## Layout - `packages/` 3782 source files - `Assets/` 87 source files ## Conventions - Tests live alongside the code they cover, following `packages/app-cli/app/cli-integration-tests.test.ts`. - 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/automerge.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `.yarn/releases/yarn-4.16.0.cjs` is 2943KB. 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/laurent22/joplin.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/laurent22/joplin)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.