Report · marked 9 Oct 2026

byoungd/up

An agent can work here, but it will waste turns finding its footing.

JavaScript · 67,958 stars · 373 files · branch main

61 /100 B-

Instructions 2/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 14/14Whether an agent can install the project and get it running without a human. Full marks.Verification loop 19/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules and static type checking.Context economy 17/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

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Lint and format rules

A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

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 14/14 A+

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

✓Deterministic install 6/6

package-lock.json pins the dependency tree.

Found package-lock.json

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (docs:dev, docs:build, docs:preview, check:content, check:navigation, check:worksheets…)

scripts/ directory

–Environment config n/a

Not applicable — this reads as a library, with no environment to configure.

✓Pinned runtime version 2/2

The language runtime version is pinned.

Found .nvmrc

–Reproducible environment n/a

Not applicable — a library doesn't need a container to be worked on.

Verification loop 19/25 B+

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

✓Tests exist 8/8

11 test files against 36 source files.

e.g. tests/accessibility.spec.mjs, tests/content/bilingual-diagnostics.test.mjs, tests/content/content-checks.test.mjs

✓Test command is discoverable 7/7

An agent can find and run `npm run check`.

✓Continuous integration 4/4

3 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 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 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 27 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.

tests/site.spec.mjs — 132KB

✗Repository weight 4/5

About 143.3MB 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 byoungd/up

# AGENTS.md

人生进阶指南 韩先凯的人生进阶指南 英语学习指南 离谱的人生 AI时代终身学习：AI、学习、创业与成长。

## Setup

```
npm ci
```

## Commands

```
npm run check              # lint and type check
npm run docs:dev
npm run docs:build
npm run docs:preview
npm run check:content
npm run check:navigation
npm run check:worksheets
npm run check:readme
```

## Layout

- `scripts/` 18 source files
- `tests/`   11 source files
- `docs/`    6 source files

## Conventions

- Tests live alongside the code they cover, following `tests/accessibility.spec.mjs`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `tests/site.spec.mjs` is 132KB. 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/byoungd/up.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good JavaScript 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](https://agentreadme.com/badge/byoungd/up.svg)](https://agentreadme.com/byoungd/up)

Other JavaScript repositories, marked

affaan-m/ECC 89 A react/react 71 B+ trekhleb/javascript-algorithms 69 B DietrichGebert/ponytail 74 B+ Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+

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