본문으로 건너뛰기

CLAUDE.md 스타터

모든 레벨

CLAUDE.md는 Claude Code에 줄 수 있는 가장 효율 높은 것입니다. 모든 세션마다 읽어들이는 영속적 지침이니까요. 이 중 하나를 저장소 루트에 두거나(또는 /init을 실행해 출발점을 생성한 뒤), 여러분에게 맞게 다듬으세요. 각 블록의 복사 버튼을 사용하세요.

:::tip 짧고 진실하게 유지하세요 길거나, 이상만 좇거나, 낡은 CLAUDE.md는 해롭습니다 — Claude는 그것을 문자 그대로 따릅니다. 프로젝트가 실제로 어떻게 동작하는지 기술하고, 가차 없이 가지치기하세요. 자세한 내용은 CLAUDE.md 페이지에 있습니다. :::

범용 스타터​

# Project: <name>

## What this is
<One or two sentences: what the project does and who uses it.>

## Tech stack
- Language/runtime: <e.g. TypeScript, Node 20>
- Framework: <e.g. Next.js 14 App Router>
- Key libraries: <e.g. Prisma, tRPC, Tailwind>

## How to run
- Install: `<cmd>`
- Dev server: `<cmd>`
- Tests: `<cmd>`
- Lint/format: `<cmd>`

## Conventions
- <e.g. Use functional components; no class components.>
- <e.g. Co-locate tests as *.test.ts next to source.>
- <e.g. Conventional Commits for messages.>

## Guardrails
- Run the tests before saying a task is done.
- Don't edit files under `/generated` or `/vendor`.
- Never commit secrets or .env files.

## Good to know
- <Gotchas, non-obvious decisions, links to deeper docs.>

Node / TypeScript 웹 앱​

# Project: <name> (Next.js + TypeScript)

## How to run
- Dev: `npm run dev`
- Build: `npm run build`
- Test: `npm test`
- Lint: `npm run lint` (must pass before commit)

## Conventions
- TypeScript strict; no `any` without a comment justifying it.
- Components in `src/components`, one folder per component.
- Data fetching via tRPC; never call the DB from a client component.
- Styling: Tailwind utility classes; no inline styles.

## Guardrails
- After any change, run `npm run lint && npm test`.
- Keep files under ~300 lines; split when larger.
- Do not modify `prisma/migrations` by hand.

Python 서비스​

# Project: <name> (FastAPI)

## How to run
- Install: `uv sync` (or `pip install -e .`)
- Dev: `uvicorn app.main:app --reload`
- Test: `pytest`
- Lint/format: `ruff check . && ruff format .`

## Conventions
- Type hints everywhere; prefer `pathlib` over `os.path`.
- Pydantic models for all request/response bodies.
- f-strings, not %-formatting.

## Guardrails
- Run `pytest` and `ruff check` before completing a task.
- Fail fast with descriptive errors; no silent excepts.

모두에게 적용되는 팁​

  • 계층화하세요. 프로젝트 전체를 위한 저장소 루트 CLAUDE.md, 그리고 영역별 규칙을 위한 하위 폴더 안의 중첩 CLAUDE.md 파일.
  • @imports를 사용하세요 기존 문서를 복제하는 대신 가져오기 위해서입니다(CLAUDE.md 레퍼런스 참조).
  • 매월 검토하세요. 낡은 지침은 없느니만 못합니다.

관련 항목​