Agent instructionsScan: passbeginner

Minimal AGENTS.md starter

A lean AGENTS.md template: project context, commands, conventions, and hard rules.

License: MIT · By waxmark · v3 · 2026-11-02

Share on X

Add a trust badge to your README

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

## What this project is

One paragraph: what the product does, who it is for, and the one thing an agent
must not break. Link the README for setup; keep this file about *how to work*.

## Commands

Run these; do not invent substitutes. Replace with your project's real commands.

- `<dev command>` — run the app locally (e.g. `pnpm dev`, `make run`)
- `<test command>` — unit + integration tests
- `<e2e command>` — browser tests, if any (note anything that must be stopped first)
- `<lint and typecheck command>` — required before a commit

## Conventions

- Match existing naming, types, and file layout before adding abstractions.
- Small diffs. One logical change per commit (Conventional Commits).
- Comments only for non-obvious business rules.

## Hard rules

- Never commit secrets, `.env`, or real credentials.
- Ask before adding a dependency, a paid service, or a schema change.
- Do not weaken auth checks, input validation, or test assertions to make something pass.
- Test fixtures stay inert: no live credentials, no functional exploit payloads.
- Update this file when a command or rule above changes.
Minimal AGENTS.md starter · Waxmark