agentreadme

Report · marked 26 Aug 2026

FreeCodeCampChina/freecodecamp.cn

An agent will struggle here, mostly for fixable reasons.

CSS · 37,778 stars · 639 files · branch dev

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
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.

The full marking

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

Instructions 2/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 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 6/20 D

Whether an agent can install the project and get it running without a human.

Deterministic install 0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (only-once, create-rev, build, start, prestart-production, start-production…)
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 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
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 18/25 B+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

Tests exist 4/8
2 test files against 191 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. test/server/utils/date-utils-test.js, test/server/utils/user-stats-test.js
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
.travis.yml defines what "passing" means.
Lint and format rules 3/3
.eslintrc encodes the house style.
Static type checking 0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 14/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 44 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.
public/js/angular.js — 1122KB
public/js/echarts-all-3.js — 527KB
full-test-data.js — 198KB
Repository weight 5/5
About 31.0MB 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 FreeCodeCampChina/freecodecamp.cn
# AGENTS.md

FCC China open source codebase and curriculum. Learn to code and help nonprofits.

## Setup

```
npm install
```

## Commands

```
npm run start                 # run the app
npm run build                 # produce a build
npm run test                  # run the test suite, must pass before any commit
npm run lint                  # lint
npm run only-once
npm run create-rev
npm run prestart-production
npm run start-production
```

## Layout

- `common/` 71 source files
- `server/` 53 source files
- `client/` 28 source files
- `public/` 20 source files
- `seed/`   8 source files
- `test/`   2 source files

## Conventions

- Tests live alongside the code they cover, following `test/server/utils/date-utils-test.js`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `public/js/angular.js` is 1122KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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/FreeCodeCampChina/freecodecamp.cn.md

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 44 out of 100

[![agent ready](https://agentreadme.com/badge/FreeCodeCampChina/freecodecamp.cn.svg)](https://agentreadme.com/FreeCodeCampChina/freecodecamp.cn)

Other CSS repositories, marked

animate-css/animate.css 45 C ryanoasis/nerd-fonts 41 C necolas/normalize.css 41 C jgthms/bulma 60 B- isocpp/CppCoreGuidelines 32 D bradtraversy/50projects50days 27 F

All CSS 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