Report · marked 25 Aug 2026
DIYgod/RSSHub
Solid foundations, held back in a few specific places.
TypeScript · 45,887 stars · 6,811 files · branch master
76
/100
B+
Instructions
20/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality and readme as an entry point.Setup
16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop
21/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.Context economy
13/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.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
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.
02
Instruction quality
Worth fixing: it never states a build, test, or run command; has no code blocks.
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 20/27 B+
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
6/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command; has no code blocks.
8,313 characters, a workable length
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 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 (build, build:docs, build:lib, build:routes, build:routes:worker, container-build…)
✗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.22.2 || ^24.15.0
✓Reproducible environment
2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 21/25 A-
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✗Tests exist
4/8
73 test files against 6723 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. .github/workflows/docker-test.yml, lib/api/category/one.test.ts, lib/api/follow/config.test.ts
✓Test command is discoverable
7/7
An agent can find and run `npm run test`.
✓Continuous integration
4/4
19 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
eslint.config.mjs encodes the house style.
✓Static type checking
3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
Context economy 13/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 39 patterns.
✗File sizes fit in context
4/6
2 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.
lib/routes/zcool/locations.ts — 147KB
lib/routes/meishichina/index.ts — 129KB
✗Repository weight
0/5
About 1168MB 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 🧡 Everything is RSSible ## Setup ``` pnpm install ``` ## Commands ``` pnpm dev # run locally pnpm start # run the app pnpm build # produce a build pnpm test # run the test suite, must pass before any commit pnpm typecheck # type check without emitting pnpm lint # lint pnpm format # format pnpm build:docs ``` ## Layout - `lib/` 6701 source files - `scripts/` 12 source files - `eslint-plugins/` 1 source file ## Conventions - Tests live alongside the code they cover, following `.github/workflows/docker-test.yml`. - 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/build-assets.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `lib/routes/zcool/locations.ts` is 147KB. 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/DIYgod/RSSHub.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/DIYgod/RSSHub)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.