Skip to content

CLAUDE.md

Latest commit

 

History

History
99 lines (68 loc) · 3.26 KB

CLAUDE.md

File metadata and controls

99 lines (68 loc) · 3.26 KB

CLAUDE.md — Your Project

Project Context

  • Repo:
  • Purpose:
  • Stack: <e.g., Python 3.12, FastAPI, PostgreSQL>
  • Status: <e.g., v0.1, MVP, production>

Language

  • All code, comments, docstrings, and variable names in English
  • All documentation and markdown in English

Code Style

  • snake_case for variables, functions, and modules
  • PascalCase for classes
  • kebab-case for file and directory names
  • Prefer explicit over implicit — no magic abbreviations
  • See .claude/rules/code-style.md for full details

Git Workflow

  • Feature branches only — never commit directly to main
  • Conventional Commits format: feat:, fix:, docs:, refactor:, test:
  • Small, focused commits with descriptive messages
  • See .claude/rules/git-workflow.md for full details

Session Protocol

Start

  1. Read this CLAUDE.md
  2. Read STATUS.md if it exists (picks up where last session left off)
  3. Confirm scope before making changes

During

  • Stay within agreed scope — do not refactor unrelated code
  • Prefer editing existing files over creating new ones
  • Run tests before committing
  • Ask before installing new dependencies

End

  • Summarize what was done and what remains
  • Update STATUS.md with handover notes
  • See .claude/rules/session-discipline.md for format

Security

  • Never commit secrets, API keys, tokens, or passwords
  • Never run destructive commands (force push, reset --hard) without approval
  • Flag any file that looks like it contains PII or credentials

Quality

  • New code should have tests
  • Linter must pass before committing
  • No TODO comments without a linked issue
  • Documentation updated alongside code changes

Project-Specific Rules

Testing