Skip to content
Vibecoding Guide

CLAUDE.md Template

Copy this into a CLAUDE.md at the root of any project. Fill in the sections that apply; delete the rest.

# [Project Name] — AI Assistance Contract
## What This Project Is
[One paragraph: what this project does, who it's for, and what it's built with.]
## Tech Stack
- **Language / Runtime:** [e.g. TypeScript, Python 3.12, Node 22]
- **Framework:** [e.g. Next.js App Router, FastAPI, Astro]
- **Package manager:** [e.g. npm, pnpm, uv]
## Project Structure
[Directory map — helps Claude know where things live without scanning]
```
src/ ← application code
tests/ ← test files
docs/ ← documentation
public/ ← static assets
```
## Commands
```bash
npm run dev # start dev server
npm run build # production build
npm test # run tests
npm run lint # lint
```
## Scope
[Bullet list of what's in scope for AI work — content areas, systems, features.]
## Execution Constraints
[Optional — add constraints if you want to limit how Claude reads your project.
Example: "Do not modify config files without explaining why."
Example: "Only read files I name explicitly — don't scan with Glob or Grep."]
## Style
- [Language/framework conventions — e.g. "use TypeScript strict mode"]
- [Naming conventions — e.g. "snake_case for variables, PascalCase for components"]
- [Formatting — e.g. "2-space indent, no semicolons"]
## Rules for AI Assistance
- Do not add dependencies without being asked.
- Do not modify configuration files without explaining why.
- Never invent facts about the codebase — if uncertain, flag it.
- [Add your own project-specific rules here]