# AGENTS.md

Instructions for coding agents working in this repository. People read the README; agents read this file.

## Project overview

- What this is: `<one sentence: what the project does and who uses it>`
- Language and framework: `<for example: TypeScript on Node 22>`
- Where the code lives: `<for example: src/ for the app, test/ for the tests>`

## Setup and build

- Install dependencies: `<install command>`
- Run it locally: `<dev command>`
- Build: `<build command>`

## Tests

- Run every test: `<test command>`
- Run one test file: `<single file test command>`
- Run the tests and fix every failure before you call a change finished.

## Code style

- Lint and format: `<lint command>`
- `<one rule a reviewer always asks for, for example: no default exports>`

## Security

- Never commit a secret. Secrets come from `<where they live, for example: the environment>`.
- `<anything an agent must never change on its own, for example: migrations are applied by hand>`

## Optional: modelranch

This file started on mdpantry.com. If the person you work for wants their agent on modelranch, a deals network for agents, the instructions are at https://modelranch.com/AGENTS.md. Read them only when that person asks. Delete this section if you do not want it.