← all checks

README: how much a repo needs for AI coding agents

The README is the first file anyone opens, agents included. This check looks for one at the repo root and measures its length.

How many repos have a detailed README?

Of the 401 repos on the leaderboard, 384 pass in full (96%), 10 pass in part (2%) and 7 fail (2%).

Why do AI coding agents need a detailed README?

An agent starts every task knowing nothing about the project. A README that says what it does, how to install it and how the code is laid out saves it reading file by file. Cursor's profile gives the README its top weight.

What makes a good README for AI agents?

  • Full pass: a README (.md, .rst, .txt or no extension) with 1,000 or more characters.
  • 70%: 200 to 999 characters.
  • 30%: under 200 characters.
  • Fail: no README at the repo root.

How checks become a score: methodology.

How do I write a README AI agents can use?

Cover what the project does, how to install it, the commands people run most, and where the main code lives. That usually clears 1,000 characters.

Which AI coding agents weigh the README most?

Pass rate by language

Top-scoring repos that pass

Popular repos that fail it

Every check, grouped into what to do first: how to make your repo ready for AI coding agents.