agentreadme

Report · marked 10 Oct 2026

affaan-m/ECC

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

JavaScript · 276,227 stars · 4,293 files · branch main

Fix these first

01
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.
02
README as an entry point
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
03
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.

The full marking

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

Instructions 24/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: CLAUDE.md, Copilot instructions
✓Instruction quality 12/12
Specific enough that an agent can act on it.
13,079 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 0/3
No README. This is the first file anything reads, human or machine.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 18/18 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 (welcome, catalog:check, context-profiles:check, catalog:sync, command-registry:generate, command-registry:write…)
pyproject.toml scripts
scripts/ directory
✓Environment config 4/4
.env.example documents what the app needs to run.
✓Pinned runtime version 2/2
The language runtime version is pinned.
Found .tool-versions
–Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 24/25 A+

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

✓Tests exist 8/8
467 test files against 1069 source files.
e.g. .github/workflows/reusable-test.yml, .opencode/commands/go-test.md, .opencode/commands/rust-test.md
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
12 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
eslint.config.js encodes the house style.
✗Static type checking 2/3
Type checking is configured, but not in strict mode.
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 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 71 patterns.
✗File sizes fit in context 0/6
10 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.
ecc2/src/tui/dashboard.rs — 539KB
ecc2/src/main.rs — 442KB
ecc2/src/session/store.rs — 312KB
✗Repository weight 4/5
About 57.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 affaan-m/ECC
# AGENTS.md

The agent harness performance optimization system. Skills, instincts, memory, security, and research-first development for Claude Code, Codex, Opencode, Cursor and beyond.

## Setup

```
yarn install
```

## Commands

```
yarn test                        # run the test suite, must pass before any commit
yarn lint                        # lint
yarn welcome
yarn catalog:check
yarn context-profiles:check
yarn catalog:sync
yarn command-registry:generate
yarn command-registry:write
```

## Layout

- `tests/`   385 source files
- `scripts/` 329 source files
- `skills/`  133 source files
- `docker/`  116 source files
- `src/`     21 source files
- `ecc2/`    17 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/reusable-test.yml`.
- 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

- `ecc2/src/tui/dashboard.rs` is 539KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/affaan-m/ECC.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 89 out of 100

[![agent ready](https://agentreadme.com/badge/affaan-m/ECC.svg)](https://agentreadme.com/affaan-m/ECC)

Other JavaScript repositories, marked

react/react 71 B+ trekhleb/javascript-algorithms 69 B DietrichGebert/ponytail 74 B+ Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+ vercel/next.js 78 A-

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