agent-readme.md - /examples
examples/ - Templates

# templates · copy, paste, edit

Starter templates

Drop one of these at your repo root as AGENT-README.md, then fill in the blanks.

Blank skeleton

Every recommended section, empty and commented. Start here for anything.

View / download →

Node / TypeScript

npm commands, strict TS conventions, and sensible guardrails.

View / download →

.NET

dotnet build/test/format, nullable + NuGetAudit guardrails.

View / download →

Python

pytest, mypy, and ruff, with a clean src-layout convention.

View / download →

How to use one

  1. Open a template and copy its contents.
  2. Save it as AGENT-README.md at the root of your repository.
  3. Replace the placeholders with your project's real commands and rules.
  4. Keep it short. If a section does not apply, delete it.
The best AGENT-README.md is the one that is accurate today. A stale command is worse than no command - review it when your build or test process changes.

New to the idea? Read the draft spec or see this site's own agent-readme.md.