Report · marked 26 Aug 2026
novuhq/novu
Solid foundations, held back in a few specific places.
TypeScript · 39,669 stars · 10,683 files · branch next
79
/100
A-
Instructions
25/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on 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
22/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 static type checking.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
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 25/27 A+
Whether the repo tells an agent how to behave before it starts guessing.
✓Agent instruction file
12/12
AGENTS.md is present, which is the format the most tools read.
✗Instruction quality
10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
2,426 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
✓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
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
package.json scripts (bootstrap, build:api, build:dashboard, build:inbound-mail, build:packages, build:v2…)
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 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
6/8
681 test files against 8432 source files.
e.g. .idea/runConfigurations/API___TEST.xml, .idea/runConfigurations/WIDGET___TEST.xml, .idea/runConfigurations/WORKER___TEST.xml
✓Test command is discoverable
7/7
An agent can find and run `npm run check`.
✓Continuous integration
4/4
40 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
biome.json 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 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 78 patterns.
✗File sizes fit in context
0/6
6 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.
.agents/skills/figma-use/references/plugin-api-standalone.d.ts — 445KB
enterprise/workers/step-resolver/worker-configuration.d.ts — 404KB
packages/framework/src/jsonSchemaFaker.js — 229KB
✗Repository weight
2/5
About 491MB 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 The open-source communication infrastructure for agents and products ## Setup ``` pnpm install ``` ## Commands ``` pnpm start # run the app pnpm build # produce a build pnpm lint # lint pnpm format # format pnpm check # lint and type check pnpm bootstrap pnpm build:api pnpm build:dashboard ``` ## Layout - `apps/` 4096 source files - `libs/` 2337 source files - `packages/` 1732 source files - `playground/` 201 source files - `enterprise/` 26 source files - `scripts/` 22 source files ## Conventions - Tests live alongside the code they cover, following `.idea/runConfigurations/API___TEST.xml`. - 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/agent-evals.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `.agents/skills/figma-use/references/plugin-api-standalone.d.ts` is 445KB. 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/novuhq/novu.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/novuhq/novu)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.