Report · marked 25 Aug 2026
toeverything/AFFiNE
An agent can work here, but it will waste turns finding its footing.
TypeScript · 71,874 stars · 10,109 files · branch canary
55
/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
16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop
17/22Whether 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 lint and format rules.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
7/10How quickly anything new can orient itself. Losing marks on license.
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
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.
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 16/20 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 (affine, af, dev, build, lint:format, lint:format:fix…)
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
2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 17/22 B+
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✗Tests exist
6/8
1169 test files against 7828 source files.
e.g. .github/helm/affine/charts/front/templates/tests/test-connection.yaml, .github/helm/affine/charts/gcloud-sql-proxy/templates/tests/test-connection.yaml, .github/helm/affine/charts/graphql/templates/tests/test-connection.yaml
✓Test command is discoverable
7/7
An agent can find and run `npm run test`.
✓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
n/a
Not applicable — the Rust compiler type checks every build.
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 73 patterns.
✗File sizes fit in context
0/6
8 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.18.0.cjs — 3696KB
packages/frontend/i18n/src/i18n.gen.ts — 327KB
packages/common/graphql/src/schema.ts — 245KB
✗Repository weight
2/5
About 452MB 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 There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use. ## Setup ``` yarn install ``` ## Commands ``` yarn dev # run locally yarn build # produce a build yarn test # run the test suite, must pass before any commit yarn typecheck # type check without emitting yarn lint # lint yarn affine yarn af yarn lint:format ``` ## Layout - `packages/` 4728 source files - `blocksuite/` 2728 source files - `tests/` 305 source files - `tools/` 50 source files - `scripts/` 10 source files ## Conventions - Tests live alongside the code they cover, following `.github/helm/affine/charts/front/templates/tests/test-connection.yaml`. - TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it. - CI defines what passing means. See `.github/workflows/auto-labeler.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `.yarn/releases/yarn-4.18.0.cjs` is 3696KB. 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/toeverything/AFFiNE.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/toeverything/AFFiNE)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.