agentreadme

Report · marked 10 Oct 2026

google/comprehensive-rust

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

Rust · 33,413 stars · 871 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
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.

The full marking

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

Instructions 3/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 3/3
README has a clear getting-started section.
Setup 6/14 C

Whether an agent can install the project and get it running without a human.

✓Deterministic install 6/6
cargo.lock pins the dependency tree.
Found cargo.lock
✗Discoverable commands 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
–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 17/22 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
15 test files against 113 source files.
e.g. tests/README.md, tests/package-lock.json, tests/package.json
✓Test command is discoverable 7/7
An agent can find and run `cargo test`.
✓Continuous integration 4/4
10 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 n/a
Not applicable — the Rust compiler type checks every build.
Context economy 20/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 20 patterns.
✓File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
✓Repository weight 5/5
About 29.1MB 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 google/comprehensive-rust
# AGENTS.md

This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `src/`              76 source files
- `tests/`            11 source files
- `mdbook-course/`    9 source files
- `third_party/`      7 source files
- `theme/`            4 source files
- `mdbook-exerciser/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `tests/README.md`.
- CI defines what passing means. See `.github/workflows/apt-get-install/action.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/google/comprehensive-rust.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good Rust 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 58 out of 100

[![agent ready](https://agentreadme.com/badge/google/comprehensive-rust.svg)](https://agentreadme.com/google/comprehensive-rust)

Other Rust repositories, marked

ultraworkers/claw-code 71 B+ clash-verge-rev/clash-verge-rev 91 A farion1231/cc-switch 63 B openai/codex 61 B- rustdesk/rustdesk 72 B+ rust-lang/rust 65 B

All Rust 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