agentreadme

Report Β· marked 9 Oct 2026

RSSNext/Folo

Ready for an agent to work in without hand-holding.

TypeScript Β· 39,079 stars Β· 3,685 files Β· branch dev

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
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.
03
Reproducible environment
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.

The full marking

Every deduction below names the file or setting it came from.

Instructions 27/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.
Also found: Copilot instructions
βœ“Instruction quality 12/12
Specific enough that an agent can act on it.
7,680 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
βœ“README as an entry point 3/3
README has a clear getting-started section.
Setup 14/20 B+

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:packages, build:web, dedupe:locales, depcheck, dev:web, format…)
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 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
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
158 test files against 2776 source files.
e.g. .github/scripts/build-ota-release.test.ts, .github/scripts/extract-release-info.test.ts, .github/scripts/release-workflow-guards.test.ts
βœ“Test command is discoverable 7/7
An agent can find and run `npm run test`.
βœ“Continuous integration 4/4
16 GitHub Actions workflows define what "passing" means.
βœ“Lint and format rules 3/3
eslint.config.mjs 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 17/20 A

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
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.
apps/ota/src/__tests__/sync.test.ts β€” 105KB
βœ—Repository weight 4/5
About 77.9MB checked out, which is comfortable.

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 β€” drafted for RSSNext/Folo
# AGENTS.md

🧑 Folo is the AI RSS Reader

## Setup

```
pnpm install
```

## Commands

```
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:packages
pnpm build:web
pnpm dedupe:locales
pnpm depcheck
```

## Layout

- `apps/`         2264 source files
- `packages/`     447 source files
- `store-assets/` 31 source files
- `scripts/`      8 source files
- `plugins/`      5 source files
- `api/`          1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/build-ota-release.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/build-android.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `apps/ota/src/__tests__/sync.test.ts` is 105KB. 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/RSSNext/Folo.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good TypeScript AGENTS.md looks like covers what to add by hand, and what AGENTS.md is explains the format itself.

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 88 out of 100

[![agent ready](https://agentreadme.com/badge/RSSNext/Folo.svg)](https://agentreadme.com/RSSNext/Folo)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 73 B+ nilbuild/developer-roadmap 45 C deepseek-ai/deepseek-harness 82 A- vuejs/vue 67 B anomalyco/opencode 78 A-

All TypeScript repositories

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.

Open an issue, already filled in