[Claude] CLAUDE.md 에 대하여

claude code에서 사용자가 prompt 를 전송하면 agentic 이 그 명령을 실행하기 위해 아래의 그림과 같은 동작을 한다.

 

출처 : claude code docs

 

여기서 첫번째

"Gather context" 라는 부분은 "관련 정보를 자동으로 수집한다" 라는 의미로 해석할 수 있다.

 

관련 정보라는 건 다음과 같은 업무가 될 수 있다.

 

관련 파일
프로젝트 구조
CLUADE.md (프로젝트 규칙) 
최근 변경사항
에러 로그

 

 

CLAUDE.md 는 claude 가 "Gather context"를 할 때, 참조하는 문서라서, 프로젝트마다 잘 세팅해두면 매번 설명하지 않아도 통일된 규칙으로 코딩할 수 있다.

(단, 최초 대화를 시작할 때 1번만) 

Claude Code 실행 → CLAUDE.md 자동으로 읽음 → 대화 내내 컨텍스트에 유지

 

 

CLAUDE.md 역할

용도	예시
코딩 규칙	네이밍 컨벤션, 폴더 구조
프로젝트 설명	어떤 서비스인지, 기술 스택
금지 사항	"이 파일은 건드리지 마"
자주 쓰는 명령어	빌드, 테스트 방법

 

sample

# CLAUDE.md

## 프로젝트 개요
> 간단한 설명 한 줄

## 기술 스택
- Backend: NestJS + TypeScript
- Frontend: Next.js + React
- Database: PostgreSQL

## 디렉토리 구조
```
src/
├── controllers/    # 요청 처리
├── services/       # 비즈니스 로직
├── models/         # 데이터 모델
└── utils/          # 유틸리티
```

## 코딩 규칙
- 변수/함수: `camelCase`
- 클래스: `PascalCase`
- 상수: `UPPER_SNAKE`
- 타입 명시 필수
- 함수 20줄 이상이면 분리

## 금지 사항
- 하드코딩 (환경변수 사용)
- print 대신 logger 사용
- 전역 상태 사용 금지

## Git 커밋
```
feat: 새 기능
fix: 버그 수정
refactor: 리팩토링
docs: 문서 수정
```

 

참고로 프로젝트마다 생성하는 CLAUDE.md 외에 전역변수처럼 나의 스타일을 지정하고 싶을 때, 

~/.claude/CLAUDE.md 를 이용한다.