agentreadme

Report · marked 25 Aug 2026

FiloSottile/mkcert

An agent will struggle here, mostly for fixable reasons.

Go · 59,498 stars · 16 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
Tests exist
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.

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 10/18 B-

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

Deterministic install 6/6
go.sum pins the dependency tree.
Found go.sum
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 2/4
Env vars are mentioned in the README but there's no example file to copy.
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.
go.mod declares a Go version
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 4/22 F

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

Tests exist 0/8
No test files found. An agent has no way to know whether its change broke anything.
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.
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
2 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 Go compiler type checks every build.
Context economy 17/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 0/3
No .gitignore.
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 1.8MB 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 FiloSottile/mkcert
# AGENTS.md

A simple zero-config tool to make locally trusted development certificates with any names you'd like.

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Conventions

- There are no tests yet. An agent has no way to check its own work here.
- CI defines what passing means. See `.github/workflows/release.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/FiloSottile/mkcert.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 41 out of 100

[![agent ready](https://agentreadme.com/badge/FiloSottile/mkcert.svg)](https://agentreadme.com/FiloSottile/mkcert)

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 85 A golang/go 30 D kubernetes/kubernetes 72 B+ microsoft/TypeScript 82 A- fatedier/frp 96 A+

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