forked from bchanot/claude
final version seems
This commit is contained in:
+48
-17
@@ -1,74 +1,105 @@
|
||||
# <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.
|
||||
# Generated by /init-project. Single source of truth for Claude in this repo.
|
||||
# Global rules: ~/.claude/CLAUDE.md — this file extends or overrides them.
|
||||
|
||||
---
|
||||
|
||||
## Project overview
|
||||
|
||||
<!-- FILL: 2–4 sentences. What does this project do and for whom. -->
|
||||
<!-- What it does and for whom. 2-4 sentences. -->
|
||||
<!-- Ex: REST API for managing food delivery orders. Exposes CRUD endpoints consumed by a React frontend. Single-tenant, deployed on a VPS via Docker Compose. -->
|
||||
|
||||
---
|
||||
|
||||
## Stack
|
||||
|
||||
<!-- FILL: language + version, framework, runtime, database, key services -->
|
||||
<!-- language+version, framework, runtime, database, key services -->
|
||||
<!-- Ex: Python 3.12 / FastAPI / PostgreSQL 16 / Redis 7 / Docker Compose -->
|
||||
|
||||
---
|
||||
|
||||
## Build commands
|
||||
|
||||
<!-- FILL: exact commands to build the project -->
|
||||
<!-- Exact commands — native and Docker if applicable -->
|
||||
<!-- Ex:
|
||||
Native : uvicorn src.main:app --reload
|
||||
Docker : docker compose up --build
|
||||
Build : docker build -t myapp .
|
||||
-->
|
||||
|
||||
---
|
||||
|
||||
## Test commands
|
||||
|
||||
<!-- FILL: exact commands to run tests -->
|
||||
<!-- Ex: pytest src/tests/ -v --cov=src -->
|
||||
|
||||
---
|
||||
|
||||
## Lint / format commands
|
||||
|
||||
<!-- FILL: exact commands, or N/A -->
|
||||
<!-- Ex: ruff check . && black --check . && mypy src/ -->
|
||||
<!-- Or: N/A -->
|
||||
|
||||
---
|
||||
|
||||
## Folder structure
|
||||
|
||||
<!-- FILL: actual tree of the project -->
|
||||
<!-- Actual tree — fill after scaffolding -->
|
||||
<!-- Ex:
|
||||
src/
|
||||
main.py — app init, lifespan hooks
|
||||
routes/ — one file per resource
|
||||
models/ — SQLAlchemy models
|
||||
schemas/ — Pydantic schemas
|
||||
services/ — business logic
|
||||
tests/
|
||||
conftest.py
|
||||
test_orders.py
|
||||
-->
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
<!-- FILL: module responsibilities, data flow, key design decisions -->
|
||||
<!-- Module responsibilities, data flow, key design decisions -->
|
||||
<!-- Ex: Request → router → service (business logic) → repository (DB) → response.
|
||||
Auth: JWT validated in a FastAPI dependency injected at router level. -->
|
||||
|
||||
---
|
||||
|
||||
## Project conventions
|
||||
|
||||
<!-- FILL: naming style, file organization, patterns specific to this project -->
|
||||
<!-- Naming, file organization, patterns specific to this project -->
|
||||
<!-- Ex: snake_case everywhere. Route files named after the resource (orders.py, users.py).
|
||||
All DB access goes through repository classes, never direct in routes. -->
|
||||
|
||||
---
|
||||
|
||||
## Exceptions to global rules
|
||||
|
||||
<!-- FILL: explicit overrides of ~/.claude/CLAUDE.md, or write "none — global rules apply" -->
|
||||
<!-- Explicit overrides of ~/.claude/CLAUDE.md, or: -->
|
||||
<!-- none — global rules apply -->
|
||||
|
||||
---
|
||||
|
||||
## Key dependencies
|
||||
|
||||
<!-- FILL: library name — purpose, one line each -->
|
||||
<!-- library — purpose, one line each -->
|
||||
<!-- Ex:
|
||||
fastapi — web framework
|
||||
sqlalchemy — ORM
|
||||
alembic — DB migrations
|
||||
pydantic — validation/serialization
|
||||
pytest — test framework
|
||||
ruff — linter
|
||||
-->
|
||||
|
||||
---
|
||||
|
||||
## 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. -->
|
||||
<!-- How Claude should behave in this repo -->
|
||||
<!-- Ex: Always run pytest after any model/service change.
|
||||
Never modify migration files — generate new ones with alembic revision.
|
||||
Ask before touching the auth dependency or JWT logic. -->
|
||||
|
||||
Reference in New Issue
Block a user