agentreadme

Report · marked 25 Aug 2026

maybe-finance/maybe

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

Ruby · 54,309 stars · 1,644 files · branch main

Fix these first

01
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.
02
Agent instruction file
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
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 9/12
CLAUDE.md is present, but not the vendor-neutral AGENTS.md.
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
Instruction quality 12/12
Specific enough that an agent can act on it.
10,952 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 3/3
README has a clear getting-started section.
Setup 20/20 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 (style:check, style:fix, lint, lint:fix, format:check, format)
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 .ruby-version
Reproducible environment 2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 15/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
298 test files against 887 source files.
e.g. .env.test.example, app/controllers/api/v1/test_controller.rb, test/application_system_test_case.rb
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
3 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
biome.json encodes the house style.
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 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 64 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 6.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 maybe-finance/maybe
undefined

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/maybe-finance/maybe.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 85 out of 100

[![agent ready](https://agentreadme.com/badge/maybe-finance/maybe.svg)](https://agentreadme.com/maybe-finance/maybe)

Other Ruby repositories, marked

rails/rails 66 B jekyll/jekyll 50 C+ mastodon/mastodon 67 B huginn/huginn 60 B- Homebrew/brew 64 B discourse/discourse 62 B

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