agentreadme

Report Β· marked 25 Aug 2026

vuetifyjs/vuetify

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

TypeScript Β· 41,035 stars Β· 3,023 files Β· branch master

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
Test command is discoverable
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface β€” an agent tries `npm test` and `make test` before it tries reading your CI config.

The full marking

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

Instructions 1/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 1/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
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 (dev, build, lint, lint:fix, version, prepare…)
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 2/2
dockerfile gives a known-good environment.
Verification loop 16/25 B

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

βœ—Tests exist 6/8
199 test files against 2120 source files.
e.g. packages/vuetify/src/__tests__/framework.spec.browser.tsx, packages/vuetify/src/components/VAlert/__tests__/VAlert.spec.browser.tsx, packages/vuetify/src/components/VAppBar/__tests__/VAppBar.spec.browser.tsx
βœ—Test command is discoverable 0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface β€” an agent tries `npm test` and `make test` before it tries reading your CI config.
βœ“Continuous integration 4/4
6 GitHub Actions workflows define what "passing" means.
βœ“Lint and format rules 3/3
.eslintrc.cjs encodes the house style.
βœ“Static type checking 3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
Context economy 19/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 18 patterns.
βœ“File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
βœ—Repository weight 4/5
About 99.4MB 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 vuetifyjs/vuetify
# AGENTS.md

πŸ‰ Vue Component Framework

## Setup

```
pnpm install
```

## Commands

```
pnpm dev           # run locally
pnpm build         # produce a build
pnpm lint          # lint
pnpm lint:fix
pnpm version
pnpm prepare
pnpm postversion
pnpm clean
```

## Layout

- `packages/`  2094 source files
- `scripts/`   20 source files
- `templates/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `packages/vuetify/src/__tests__/framework.spec.browser.tsx`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- 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.

---

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/vuetifyjs/vuetify.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 56 out of 100

[![agent ready](https://agentreadme.com/badge/vuetifyjs/vuetify.svg)](https://agentreadme.com/vuetifyjs/vuetify)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 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