Claude Code 프로젝트 지침(CLAUDE.md) 작성하기

언제 사용하나

Claude Code가 저장소 규칙을 따르도록 프로젝트 루트에 지침 파일을 둘 때.

작성 전 확인

• 실제 빌드·테스트 명령과 금지 사항(예: 특정 브랜치 직접 push 금지)을 정리한다.
• 문서가 길수록 지켜지지 않으니 핵심만 담는다.

복사해서 쓰는 템플릿 (CLAUDE.md)

# 프로젝트 지침

## 기술 스택
- {{STACK}}

## 명령
- 빌드: `{{BUILD_CMD}}`
- 테스트: `{{TEST_CMD}}`
- 실행 금지: {{FORBIDDEN}}

## 코드 규칙
- {{CONVENTIONS}}

## 하지 말아야 할 것
- {{DONTS}}

placeholder 설명

• {{STACK}} / {{BUILD_CMD}} / {{TEST_CMD}} : 스택과 명령
• {{FORBIDDEN}} / {{DONTS}} : 금지 명령/행동

입력 예시

{{TEST_CMD}} = ./gradlew test

기대 결과

에이전트가 규칙·명령을 따르는 일관된 작업.

검증 방법

간단한 작업을 시켜 지침(명령/금지)을 지키는지 확인한다.

주의사항과 흔한 실수

• 실제로 존재하는 명령만 적는다(없는 스크립트를 적지 않는다).
• 비밀값을 지침 파일에 넣지 않는다.

관련 문서

• Claude Code 문서: https://docs.claude.com/en/docs/claude-code