HeyDeer에 코드베이스 알려주기
검토 지침
검토 지침은 HeyDeer에 무엇을 우선시할지, 무엇을 건드리지 않을지, 피드백을 어떻게 표현할지 알려 줍니다. 지침은 HeyDeer에 저장되므로 풀 리퀘스트가 바꿀 수 없습니다.
지침 추가
- 워크스페이스 설정 → 검토 지침을 여세요. 저장소 하나에만 적용하려면 저장소 → (저장소) → 검토 지침을 여세요.
- 일반 텍스트나 Markdown으로 최대 12,000자까지 작성하세요.
- 워크스페이스 지침 저장 또는 저장소 지침 저장을 선택하세요.
- 워크스페이스 지침은 모든 저장소에 적용됩니다. 저장소 지침은 워크스페이스 지침에 더해지며, 둘이 충돌하면 저장소 지침이 우선합니다.
- 저장소 페이지의 통합 지침 미리 보기에서 두 지침을 순서대로 볼 수 있습니다.
- 변경 사항은 저장한 후에 요청된 검토부터 적용됩니다.
- 워크스페이스 관리자만 지침을 편집할 수 있습니다.
- 지침에 비밀번호, 토큰 등의 비밀 정보를 넣지 마세요.
지침에 넣을 내용
지침에는 HeyDeer가 검토할 때만 의미 있는 가이드를 넣습니다. 우선순위, 건드리지 않을 부분, 팀에서 쓰는 용어, 피드백 표현 방식이 해당합니다.
코딩 컨벤션은 코딩 에이전트도 따를 수 있도록 AGENTS.md에 두세요. HeyDeer가 해당하는 모든 풀 리퀘스트에서 반드시 확인해야 하는 요구 사항은 저장소 검사에 두세요.
이런 가이드를 관련 코드 옆에 두고 저장소에서 관리하려면 REVIEW.md를 사용하세요. 풀 리퀘스트는 REVIEW.md를 바꿀 수 있으므로, 바뀌면 안 되는 내용은 지침에 두세요.
지침은 REVIEW.md, AGENTS.md, 스킬보다 우선하지만, 저장소 검사의 실행을 막을 수는 없습니다. 가이드가 서로 충돌하는 경우를 참고하세요.
효과적인 지침 작성하기
무언가를 작성하기 전에 HeyDeer가 몇 개의 풀 리퀘스트를 검토하게 하세요. 반복되는 누락이나 원치 않는 댓글이 있으면 그에 대한 지침을 한 번에 몇 개씩 추가하고, 다음 검토를 읽어 효과를 확인하세요.
- 지침을 우선순위(Priorities), 건드리지 않을 부분(Leave alone), 용어(Terms), 피드백(Feedback) 같은 몇 개의 제목 아래에 묶으세요.
- 글머리 기호 하나에 지침 하나를 적고, 지침이 다루는 경로, 함수, 라이브러리를 명시하세요.
- 이유가 분명하지 않으면 이유를 덧붙이세요.
- 제외 범위는 좁게 유지하세요. “스크립트에 댓글을 달지 마세요”가 아니라 “scripts/one-off/의 파일에는 댓글을 달지 마세요”처럼 적으세요. 전자는 실제 버그까지 가립니다.
- HeyDeer가 결과를 보고하는 방식은 지침 대신 설정으로 정하세요: 검토 언어, 피드백 범위, 자동 승인.
## Priorities
- Code under src/payments/ is high risk. Look hardest at retries,
refunds and anything that could charge a customer twice.
## Leave alone
- Files under scripts/one-off/. They run once by hand and are deleted.
- Formatting. The formatter runs in CI.
## Terms
- A "workspace" is a customer account, not a folder on disk.
## Feedback
- Name the input that triggers a bug, and suggest the smallest fix.지침이 무시되는 것 같다면 문제 해결을 참고하세요.