REVIEW.md
코드 검토에서만 의미 있는 가이드는 REVIEW.md에 두세요. 무엇을 확인할지, 무엇을 건드리지 않을지, 문제가 얼마나 심각한지가 해당합니다. Claude Code Review 같은 다른 코드 검토 도구도 같은 파일을 읽으므로, 기존 REVIEW.md를 그대로 쓸 수 있습니다.
작성할 내용
- 모든 풀 리퀘스트에서 확인할 내용. 예를 들어 데이터베이스 쿼리의 범위를 어떻게 제한하는지입니다.
- 건드리지 않을 부분. 예를 들어 CI가 이미 보고하는 문제입니다. 제외 범위는 좁게 유지하고, 적용되는 경로를 명시하세요.
- 어떤 종류의 문제가 팀에 얼마나 심각한지. HeyDeer의 심각도(치명적, 높음, 보통, 낮음)로 적으세요.
REVIEW.md
# Review instructions
## Always check
- Database queries in src/api/ are scoped to the caller's
workspace.
- Log lines don't include email addresses or request bodies.
## Leave alone
- Formatting and lint issues. CI enforces them.
- Code in tests/fixtures/ that breaks production rules on purpose.
## Severity
- A migration that isn't backward compatible is High.
- Naming and refactoring suggestions are Low.코딩 컨벤션은 코딩 에이전트도 따를 수 있도록 AGENTS.md에 두세요. HeyDeer가 해당하는 모든 풀 리퀘스트에서 반드시 확인해야 하는 요구 사항은 저장소 검사에 두세요.
루트 파일과 하위 디렉터리 파일
저장소 루트에 REVIEW.md를 추가하세요. 자체 가이드가 필요한 디렉터리에는 src/payments/REVIEW.md처럼 별도 파일을 둘 수 있습니다.
REVIEW.md는 해당 디렉터리와 그 하위의 변경 사항에 적용됩니다. 더 깊은 위치의 파일은 상위 파일에 내용을 더하며, 서로 충돌하면 더 깊은 위치의 파일이 우선합니다.
| 변경된 파일 | 적용되는 파일(순서대로) |
|---|---|
src/api/invoices.ts | REVIEW.md |
src/payments/refund.ts | REVIEW.md, src/payments/REVIEW.md |
설정으로 정하는 것
REVIEW.md는 HeyDeer가 무엇을 살펴보고 문제를 얼마나 심각하게 보는지를 바꾸며, 결과를 보고하는 방식은 바꾸지 않습니다. 보고 방식은 설정으로 정하세요: 검토 언어, 피드백 범위, 자동 승인. 예를 들어 심각도가 낮음인 발견 사항을 덜 게시하려면 피드백 범위를 “간결”로 선택하세요.
REVIEW.md는 저장소 검사에는 적용되지 않습니다. 일치하는 검사는 항상 실행되며, 무엇이 위반인지는 검사만이 정합니다.
생성된 파일을 건너뛰려면 대신 .gitattributes에서 표시하세요. 그러면 검토 대상에서 빠집니다. 생성된 파일을 참고하세요.
REVIEW.md를 수정하는 풀 리퀘스트
HeyDeer는 REVIEW.md를 풀 리퀘스트에서 읽으므로, 이 파일을 수정하는 풀 리퀘스트는 수정된 버전으로 검토되며 HeyDeer가 자동으로 승인하지 않습니다. 풀 리퀘스트가 바꿀 수 없어야 하는 가이드는 검토 지침에 두세요.
Claude Code Review에서 옮겨 오는 경우
기존 REVIEW.md를 그대로 쓸 수 있습니다. 다만 다음과 같은 차이가 있습니다:
- HeyDeer는 REVIEW.md를 풀 리퀘스트에서 읽지만, Claude Code Review는 기준 브랜치에서 읽습니다.
- Important는 심각도 보통 이상, Nit는 낮음에 해당합니다.
- Nit 개수 제한은 적용되지 않습니다. 대신 피드백 범위를 “간결”로 선택하세요.
- HeyDeer는
@review-security.md같은 포함 구문을 따라가지 않습니다. 포함하던 파일의 가이드를 REVIEW.md로 옮기세요.