Agent instructionsScan: pass

Minimal AGENTS.md

A universal AGENTS.md skeleton read natively by Codex, Cursor, Copilot, Gemini CLI, Claude Code, and 20+ other agents.

License: CC0-1.0 · By waxmark · v1 · 2026-11-02

Share on X

Add a trust badge to your README

[![Waxmark](https://waxmark.app/api/badge/minimal-agents-md)](https://waxmark.app/items/minimal-agents-md/scan)
Report
# {{PROJECT_NAME}}

{{ONE_LINE_PURPOSE}}. Stack: {{STACK}}. Source in `src/`, tests in `tests/`. This file is the instruction set for any coding agent working in this repository; human-oriented docs are in `README.md`.

## Setup and commands

```sh
{{INSTALL_COMMAND}}        # install dependencies (run once, and after lockfile changes)
{{DEV_COMMAND}}            # run locally
{{TEST_COMMAND}}           # full test suite
{{LINT_COMMAND}}           # lint
{{TYPECHECK_COMMAND}}      # types
{{BUILD_COMMAND}}          # production build
```

Run the test suite for just the area you changed while iterating, and the full suite before you finish.

## Definition of done

A task is complete only when all of the following are true:

1. `{{TEST_COMMAND}}`, `{{LINT_COMMAND}}`, and `{{TYPECHECK_COMMAND}}` exit 0 in this session.
2. Every behavior change has a new or updated test.
3. Your final message includes the commands you ran and their last lines of output.

Do not report success based on reasoning about the code; run the commands.

## Code conventions

- Follow the style of the file you are in. Do not reformat lines you did not change.
- New files match the naming and directory layout of their neighbors.
- Comments explain why, not what. No commented-out code.
- No new dependencies unless the task requires one; name it and the reason in your final message.

## Git

- Branch from `{{MAIN_BRANCH}}`; never commit directly to it.
- Commit message: imperative subject under 72 characters, blank line, body explaining the reason for the change.
- One logical change per commit. Separate refactors from behavior changes.
- Do not amend, rebase, or force-push commits you did not create in this session.

## Do not touch

- `{{GENERATED_DIR}}/` is generated. Edit the source and regenerate.
- Lockfiles, `.env*`, CI workflows, and `migrations/` unless the task is specifically about them.
- Anything outside this repository.

## Ask before

- Deleting files or removing public functions, endpoints, or schema fields.
- Changing authentication, authorization, billing, or data-deletion code.
- Running commands that affect systems outside this checkout: deploys, publishes, pushes to shared branches, database commands against a non-local host.

When blocked or uncertain, stop and ask one specific question rather than guessing.
Minimal AGENTS.md · Waxmark