CLAUDE.md: Claude Code가 리뷰를 포함한 모든 작업에서 읽는 프로젝트 지침입니다. Code Review는 이를 프로젝트 컨텍스트로 읽고, 이를 위반하는 변경 사항을 지적합니다.REVIEW.md: 리뷰 전용 지침입니다. 팀이 무엇을 지적하기를 원하는지, 어떤 심각도로 지적할지, 무엇을 건너뛸지 명시하는 데 사용합니다.
REVIEW.md를 추가하고 병합합니다. 그런 다음 기본 브랜치를 보호합니다.
리뷰의 철저함이나 리뷰 실행 시점을 변경하려면 Owner에게 리뷰 수준 또는 Review runs 설정을 변경하도록 요청합니다.
프로젝트 전체 규칙에는 CLAUDE.md 사용
Code Review는 저장소의CLAUDE.md 파일을 프로젝트 컨텍스트로 읽습니다. 이 파일의 규칙 중 하나를 위반하는 변경 사항은 문제에 맞는 심각도 수준의 발견 사항이 됩니다.
리뷰는 저장소 루트의 CLAUDE.md와 변경된 각 파일의 상위 디렉터리에 있는 CLAUDE.md 파일을 읽습니다. 하위 디렉터리의 CLAUDE.md는 풀 리퀘스트가 해당 경로 아래의 파일을 변경할 때 읽힙니다.
리뷰 전용 규칙에는 REVIEW.md 사용
REVIEW.md는 저장소 루트에 위치하며 Code Review를 저장소에 맞게 조정하는 파일입니다. 하위 디렉터리에 REVIEW.md를 추가하여 루트 파일에 더해 해당 경로 아래의 변경 사항에 대한 검사를 추가할 수도 있습니다.
문제를 찾는 에이전트와 이를 검증하는 에이전트는 Code Review의 기본 리뷰 지침과 함께 이 파일의 내용을 저장소의 리뷰 지침으로 전달받습니다. 최종 리뷰를 작성하는 단계는 심각도를 확정하고 요약을 작성하기 전에 이 파일을 참조합니다.
다음 예시 구조에는 루트 파일 하나와 하위 디렉터리 파일 하나가 있습니다.
Code Review 서비스와 로컬
/code-review 명령은 서로 별개의 도구이며, 읽는 파일도 다릅니다. 서비스는 CLAUDE.md와 REVIEW.md를 모두 읽습니다. 사용자의 로컬 머신에서 Claude Code 세션 안에서 실행하는 /code-review 명령은 CLAUDE.md 파일을 읽지만 REVIEW.md는 읽지 않습니다. 두 곳 모두에 적용하려는 지침은 CLAUDE.md에 작성하고, REVIEW.md에는 풀 리퀘스트 리뷰에 특화된 규칙만 둡니다.REVIEW.md 예시
이REVIEW.md는 백엔드 서비스에 맞게 심각도를 재조정하고, nit 수를 제한하고, 생성된 파일을 건너뛰고, 저장소별 검사를 추가합니다.
REVIEW.md에 작성할 내용 선택
REVIEW.md는 리뷰가 찾아내고 보고하는 내용을 변경하는 자유 형식 Markdown입니다. 리뷰의 형식은 변경하지 않습니다. 겪고 있는 문제를 찾은 다음 제시된 것과 같은 지침을 추가합니다. 예시는 처음 네 가지를 사용합니다.
- 잘못된 항목이 Important로 표시됨: 저장소에 맞게 🔴 Important의 의미를 재정의합니다. 기본 보정은 프로덕션 코드를 대상으로 하며, 문서 저장소, 구성 저장소 또는 프로토타입에는 훨씬 좁은 정의가 적합할 수 있습니다. 어떤 유형의 발견 사항이 Important이고 어떤 유형이 최대 Nit인지 명시합니다. 예를 들어 모든
CLAUDE.md위반을 Important로 취급하는 식으로 상향 조정할 수도 있습니다. - nit이 너무 많음: 단일 리뷰가 게시하는 🟡 Nit 코멘트 수를 제한합니다. “nit은 최대 5개까지만 보고”와 같은 제한을 두면 리뷰를 실행 가능한 상태로 유지할 수 있습니다.
- 생성된 파일이나 CI가 이미 검사하는 항목에 대한 코멘트: Claude가 발견 사항을 건너뛰어야 하는 경로와 발견 사항 범주를 나열합니다. 일반적인 대상은 생성된 코드, lockfile, vendored 의존성이며, 린팅이나 맞춤법 검사처럼 CI가 이미 강제하는 모든 항목도 포함됩니다. 어느 정도 리뷰는 필요하지만 전면적인 검토는 필요하지 않은 경로에는 대신 더 높은 기준을 설정합니다: “
scripts/에서는 거의 확실하고 심각한 경우에만 보고.” - 팀 규칙이 검사되지 않음: “새 API 라우트에는 통합 테스트가 있어야 함”처럼 모든 풀 리퀘스트에서 지적하려는 규칙을 추가합니다.
- 잘못된 것으로 판명되는 발견 사항: 특정 유형의 발견 사항을 게시하기 전에 근거를 요구합니다. 예를 들어 “동작에 관한 주장에는 이름에서 추론한 것이 아닌 소스의
file:line인용이 필요함”과 같은 지침은 작성자에게 불필요한 왕복을 초래할 수 있는 오탐을 줄입니다.
REVIEW.md에는 리뷰 동작을 변경하는 지침만 두고, 일반적인 프로젝트 컨텍스트는 CLAUDE.md에 둡니다.
REVIEW.md를 읽는 브랜치
Code Review는 풀 리퀘스트의 기본(base) 브랜치 또는 기본(default) 브랜치에서REVIEW.md를 읽으며, 풀 리퀘스트 자체의 변경 사항에서는 절대 읽지 않습니다. 리뷰 동작을 변경하려면 REVIEW.md 변경 사항을 먼저 병합합니다.
REVIEW.md를 기본 브랜치에 두고 해당 브랜치를 보호합니다. 아래 표의 첫 번째 행처럼 리뷰가 보호된 기본 브랜치의 사본을 읽는 경우, 루트 파일의 다음 지침을 따릅니다.
- 발견 사항의 심각도 낮추기
- 경로, 파일 또는 문제 유형 제외
- nit 코멘트 수 제한
브랜치 보호로 인정되는 항목
Code Review는 다음 설정을 보호로 인정합니다.- 기본 브랜치: 클래식 브랜치 보호 규칙 또는 ruleset
- 그 외 모든 브랜치: ruleset만 해당
브랜치 구성별로 리뷰가 읽는 항목
아래 표의 첫 번째 열에서 저장소의 상황을 찾습니다.
check run에
REVIEW.md가 언급되는 경우 The check run mentions REVIEW.md를 참조합니다.
관련 리소스
- Code Review: 서비스의 개요와 리뷰 실행 방식
- 풀 리퀘스트에서 리뷰 읽기 및 요청: 각 심각도 수준의 의미와 발견 사항이 표시되는 방식
- Code Review 설정: Owner가 설정하는 리뷰 수준과 리뷰 실행 시점
/code-review로 로컬에서 리뷰:/code-review명령, 인수 및 effort 수준- 메모리: Claude Code 전반에서
CLAUDE.md파일이 작동하는 방식