Report · marked 25 Aug 2026
pcottle/learnGitBranching
Solid foundations, held back in a few specific places.
JavaScript · 33,949 stars · 187 files · branch main
79
/100
A-
Instructions
23/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file 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
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
16/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.Navigability
7/10How quickly anything new can orient itself. Losing marks on written documentation and repository description.
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
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
Agent instruction file
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
The full marking
Every deduction below names the file or setting it came from.
Instructions 23/27 A
Whether the repo tells an agent how to behave before it starts guessing.
✗Agent instruction file
9/12
CLAUDE.md is present, but not the vendor-neutral AGENTS.md.
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
✓Instruction quality
12/12
Specific enough that an agent can act on it.
6,298 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
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
yarn.lock pins the dependency tree.
Found yarn.lock
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
package.json scripts (preinstall, build, dev, prepare, test, test:coverage)
Makefile
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.
package.json engines.node >=14.20.0
✓Reproducible environment
2/2
dockerfile gives a known-good environment.
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
23 test files against 143 source files.
e.g. __tests__/CommandLineStore.spec.js, __tests__/GlobalStateStore.spec.js, __tests__/LevelStore.spec.js
✓Test command is discoverable
7/7
An agent can find and run `npm run test`.
✓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 16/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 37 patterns.
✗File sizes fit in context
2/6
9 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.
src/js/intl/strings.js — 212KB
src/levels/remote/fetchRebase.js — 180KB
src/levels/remote/tracking.js — 162KB
✓Repository weight
5/5
About 27.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 An interactive git visualization and tutorial. Aspiring students of git can use this app to educate and challenge themselves towards mastery of git! ## Setup ``` yarn install ``` ## Commands ``` yarn dev # run locally yarn build # produce a build yarn test # run the test suite, must pass before any commit yarn preinstall yarn prepare yarn test:coverage ``` ## Layout - `src/` 114 source files - `__tests__/` 23 source files - `scripts/` 4 source files ## Conventions - Tests live alongside the code they cover, following `__tests__/CommandLineStore.spec.js`. - CI defines what passing means. See `.github/workflows/build-docker.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `src/js/intl/strings.js` is 212KB. 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/pcottle/learnGitBranching.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/pcottle/learnGitBranching)Other JavaScript 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.