75 lines
1.3 KiB
Markdown
75 lines
1.3 KiB
Markdown
# <PROJECT NAME> — CLAUDE.md
|
||
|
||
# This file was generated by /init-project.
|
||
# It is the single source of truth for Claude in this repository.
|
||
# Global rules live in ~/.claude/CLAUDE.md — this file extends or
|
||
# overrides them for this specific project.
|
||
|
||
---
|
||
|
||
## Project overview
|
||
|
||
<!-- FILL: 2–4 sentences. What does this project do and for whom. -->
|
||
|
||
---
|
||
|
||
## Stack
|
||
|
||
<!-- FILL: language + version, framework, runtime, database, key services -->
|
||
|
||
---
|
||
|
||
## Build commands
|
||
|
||
<!-- FILL: exact commands to build the project -->
|
||
|
||
---
|
||
|
||
## Test commands
|
||
|
||
<!-- FILL: exact commands to run tests -->
|
||
|
||
---
|
||
|
||
## Lint / format commands
|
||
|
||
<!-- FILL: exact commands, or N/A -->
|
||
|
||
---
|
||
|
||
## Folder structure
|
||
|
||
<!-- FILL: actual tree of the project -->
|
||
|
||
---
|
||
|
||
## Architecture
|
||
|
||
<!-- FILL: module responsibilities, data flow, key design decisions -->
|
||
|
||
---
|
||
|
||
## Project conventions
|
||
|
||
<!-- FILL: naming style, file organization, patterns specific to this project -->
|
||
|
||
---
|
||
|
||
## Exceptions to global rules
|
||
|
||
<!-- FILL: explicit overrides of ~/.claude/CLAUDE.md, or write "none — global rules apply" -->
|
||
|
||
---
|
||
|
||
## Key dependencies
|
||
|
||
<!-- FILL: library name — purpose, one line each -->
|
||
|
||
---
|
||
|
||
## Workflow expectations
|
||
|
||
<!-- FILL: how Claude should behave in this repo:
|
||
e.g. always run tests after modification, never modify unrelated files,
|
||
ask before large refactors, etc. -->
|