# CLAUDE.md — <PROJECT NAME>

<!--
  CLAUDE.md is the first thing Claude Code reads in your project.
  Keep it short, high-signal, and true. Delete guidance that doesn't apply.
  Anything here overrides Claude's default behavior — so be intentional.
-->

## What this project is

<One or two sentences: what the project does and who it's for.>

## Tech stack

- Language(s): <e.g. TypeScript, Go>
- Framework(s): <e.g. NestJS>
- Data: <e.g. PostgreSQL, MongoDB>
- Key tools: <e.g. pnpm, Docker>

## How to run / test

```bash
# install
<install command>
# dev
<run command>
# test
<test command>
```

## Project conventions

- <e.g. Organize code by feature, not by file type>
- <e.g. Prefer immutable data; return new objects instead of mutating>
- <e.g. Errors handled explicitly at boundaries; never swallow them>
- <e.g. Naming: camelCase vars, PascalCase types, UPPER_SNAKE_CASE consts>

## Directory map (optional but helpful)

```text
src/
├── <area>/   # <what lives here>
└── <area>/   # <what lives here>
```

## Guardrails (things Claude must / must not do)

- DO: <e.g. write a failing test first for new behavior>
- DO: <e.g. keep files under ~800 lines; split when larger>
- DON'T: <e.g. commit or push unless asked>
- DON'T: <e.g. add dependencies without flagging it>

## Where to look first

- Architecture notes: <path>
- Domain glossary: <path>

<!-- Tip: CLAUDE.md files can also live in subfolders for area-specific rules. -->