claude-md-starter CLAUDE.md

[PROJECT_NAME]

What This Project Does

[2-3 sentences describing the project's purpose and scope]

Tech Stack

Layer	Tech
Language	[e.g., TypeScript, Python, Go]
Framework	[e.g., Next.js, FastAPI, Express]
Database	[e.g., Postgres, MongoDB, SQLite]
Hosting	[e.g., Vercel, Railway, AWS]

Commands

[PACKAGE_MANAGER] run dev          # Start dev server
[PACKAGE_MANAGER] run build        # Production build
[PACKAGE_MANAGER] run test         # Run tests
[PACKAGE_MANAGER] run lint         # Lint all files

Conventions

Code Style

• File naming: kebab-case.ts for files, PascalCase.tsx for components
• Use const by default, let only when reassignment is needed, never var
• Prefer type over interface, never use enum (use string literal unions)
• Functions should be under 50 lines — extract if longer
• Extract magic numbers and strings to named constants

Error Handling

• Always handle errors explicitly — never swallow silently
• Use try-catch for async operations
• Return typed error objects from APIs, don't throw
• Log errors with context (what was attempted, what failed, relevant IDs)

Git

• Conventional commits: feat:, fix:, docs:, refactor:, test:
• Keep commits small and focused on one change

Things Claude Should Never Do

• Use any type — use unknown and narrow
• Use var — use const or let
• Use enum — use string literal unions
• Commit secrets, API keys, or credentials
• Use string concatenation for SQL queries (use parameterized queries)
• Use eval() or exec() with user input
• Log sensitive data (PII, passwords, tokens)
• Skip error handling on async operations
• Generate code without reading the existing file first

Project-Specific Rules

[Add rules specific to your project here — naming patterns, architectural decisions, domain-specific constraints]