agentreadme

Report Β· marked 25 Aug 2026

PatrickJS/awesome-cursorrules

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

JavaScript Β· 40,657 stars Β· 295 files Β· branch main

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
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 12/14 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 (// note, check:awesome-list:upstream, test, check:awesome-list, check:repo-hygiene, check:readme-hygiene…)
–Environment config n/a
Not applicable β€” this reads as a library, with no environment to configure.
βœ—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 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
9 test files against 19 source files.
e.g. scripts/check-awesome-list.test.mjs, scripts/check-pr-author.test.mjs, scripts/check-repo-concerns.test.mjs
βœ“Test command is discoverable 7/7
An agent can find and run `npm run test`.
βœ“Continuous integration 4/4
1 GitHub Actions workflow 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 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 2/3
.gitignore has only 4 rules.
Start from a standard template for your stack. It prevents the previous problem before it happens.
βœ“File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
βœ“Repository weight 5/5
About 2.9MB 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 PatrickJS/awesome-cursorrules
# AGENTS.md

πŸ“„  Configuration files that enhance Cursor AI editor experience with custom rules and behaviors

## Setup

```
pnpm install
```

## Commands

```
pnpm test                          # run the test suite, must pass before any commit
pnpm // note
pnpm check:awesome-list:upstream
pnpm check:awesome-list
pnpm check:repo-hygiene
pnpm check:readme-hygiene
pnpm check:rule-hygiene
pnpm check:issue-template-policy
```

## Layout

- `scripts/` 19 source files

## Conventions

- Tests live alongside the code they cover, following `scripts/check-awesome-list.test.mjs`.
- CI defines what passing means. See `.github/workflows/main.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/PatrickJS/awesome-cursorrules.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 63 out of 100

[![agent ready](https://agentreadme.com/badge/PatrickJS/awesome-cursorrules.svg)](https://agentreadme.com/PatrickJS/awesome-cursorrules)

Other JavaScript repositories, marked

react/react 71 B+ affaan-m/ECC 90 A trekhleb/javascript-algorithms 69 B Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+ vercel/next.js 77 B+

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