heydeer

자주 묻는 질문

팀이 도입 전후에 자주 묻는 질문을 모았습니다. 설정, 검토, 수정, 요금, 보안까지 다룹니다.

시작하기

HeyDeer는 어떻게 설정하나요?

GitHub를 연결하고 저장소를 고른 다음 검토를 요청하세요.

  • GitHub로 로그인하고 저장소가 있는 계정 선택에서 개인 계정이나 조직을 선택합니다. 목록에 없으면 GitHub에서 설치를 선택해 GitHub에서 고릅니다.
  • GitHub에서 Only select repositories를 선택하고 검토할 저장소를 고른 뒤 확인합니다. 조직에서는 본인이 소유자가 아니면 GitHub가 소유자에게 승인을 요청합니다.
  • HeyDeer가 알아서 검토할지 정합니다. 풀 리퀘스트 자동 검토를 켜 두면 푸시할 때마다 풀 리퀘스트당 최대 5회까지 검토하고, 끄면 요청할 때만 검토합니다.
  • 열려 있는 풀 리퀘스트에 @heydeer review 댓글을 남깁니다.

저장소에 대한 쓰기 권한이 필요합니다. 새 워크스페이스는 신용카드 없이 무료 요금제로 시작하며, 발견 사항은 풀 리퀘스트의 검토 댓글로 도착합니다.

자세히 보기: 빠른 시작
HeyDeer를 GitLab이나 Bitbucket에서도 사용할 수 있나요?
HeyDeer는 GitHub에서 공개 저장소와 비공개 저장소, 조직과 개인 계정 모두에 사용할 수 있습니다. GitHub App으로 설치되며 HeyDeer가 읽고 검토할 저장소를 직접 고르므로, 접근 범위는 검토받고 싶은 코드로 한정됩니다. 각 워크스페이스는 하나의 GitHub 계정에 속합니다. 다른 계정을 연결하려면 워크스페이스 메뉴에서 워크스페이스 추가를 선택하세요.
자세히 보기: GitHub App 및 권한
첫 검토 전에 설정해야 할 것이 있나요?

연결한 직후 바로 검토를 요청할 수 있습니다. HeyDeer는 풀 리퀘스트의 변경 사항을 저장소 전체의 맥락에서 읽고, PR 제목, 설명, 논의도 함께 살펴봅니다. 모든 검토는 처음부터 버그와 보안 문제를 찾습니다.

첫 검토에서 부족한 부분이 보이면 알맞은 곳에 가이드를 추가하세요.

  • AGENTS.md: 코드가 동작하는 방식과 따르는 컨벤션. 코딩 에이전트도 이 파일을 따릅니다.
  • REVIEW.md: 검토에서 찾아야 할 것, 건드리지 않을 것, 문제의 심각도.
  • 저장소 검사: 특정 파일을 변경하는 모든 풀 리퀘스트에서 HeyDeer가 반드시 확인해야 하는 요구 사항.
  • 검토 지침: 풀 리퀘스트로 바뀌면 안 되는 가이드나 모든 저장소에 적용되는 가이드.
자세히 보기: HeyDeer가 읽는 내용
HeyDeer는 언제 풀 리퀘스트 검토를 시작하나요?

누군가 요청하는 즉시 시작합니다. 풀 리퀘스트에 @heydeer review 댓글을 남기거나, 검토 기록 페이지에서 검토 시작을 선택하거나, HeyDeer Review 검사에서 Re-run을 선택하세요. 새 워크스페이스는 수동 검토만으로 시작하며, 설정을 마치면 HeyDeer가 자동으로 검토할지 바로 묻습니다.

워크스페이스 관리자는 워크스페이스 설정 → 검토 규칙 → 검토 시점에서 언제든지 일정을 바꿀 수 있습니다.

  • PR당 한 번: 조건에 맞는 풀 리퀘스트를 검토가 한 번 성공할 때까지 검토합니다.
  • 푸시할 때마다: 풀 리퀘스트가 처음 필터에 맞을 때 검토하고, 이후 커밋을 추가하는 푸시마다 검토합니다. 기본값은 최대 5회입니다.

자동 검토는 기본적으로 초안, 포크, 종속성 업데이트를 건너뜁니다.

자세히 보기: 자동 검토
HeyDeer에 GitHub 소유자의 승인을 기다리는 중이라고 표시되는 이유는 무엇인가요?
GitHub 조직에서는 소유자만 HeyDeer GitHub App을 설치할 수 있습니다. 그래서 다른 사람이 연결하면 GitHub가 소유자에게 요청을 보내고, HeyDeer에는 GitHub 소유자의 승인을 기다리는 중이 표시됩니다. 워크스페이스 관리자는 기다리는 동안 설정을 마쳐 둘 수 있으므로, 처음부터 원하는 방식으로 검토를 시작할 수 있습니다. 소유자가 GitHub에서 승인하면 워크스페이스가 자동으로 연결되고, HeyDeer가 워크스페이스 알림 이메일 주소로 메일을 보냅니다.
자세히 보기: GitHub App 및 권한
저장소를 더 추가하려면 어떻게 하나요?
저장소 페이지에서 저장소 추가를 선택하거나, 워크스페이스 설정 → GitHub 연결에서 GitHub 접근 권한 관리를 선택한 다음 GitHub에서 저장소를 고르세요. 변경 사항은 GitHub 계정의 소유자만 저장할 수 있습니다. 다른 사람에게는 팀에 요청이 표시되며, 복사해서 소유자에게 보낼 수 있는 요청문이 함께 제공됩니다. 추가한 저장소는 검토 규칙의 워크스페이스 기본값을 따르므로 곧바로 다른 저장소와 똑같이 검토됩니다. 나중에 만드는 저장소도 포함하려면 GitHub에서 모든 저장소를 선택하세요.
자세히 보기: GitHub App 및 권한
HeyDeer를 팀에 어떻게 도입하면 좋을까요?

단계적으로 도입하고, 팀이 결과를 신뢰하게 되면 HeyDeer의 결과를 병합 조건으로 삼으세요.

  • 몇 개의 풀 리퀘스트로 시험해 보기: 자동 검토를 끈 상태로 성격이 다른 풀 리퀘스트 몇 개에 @heydeer review 댓글을 남기고, 발견 사항을 팀 검토자의 의견과 비교합니다.
  • 그 검토에서 드러난 빈틈 메우기: 컨벤션은 AGENTS.md에, 요구 사항은 저장소 검사에, 우선순위는 검토 지침에 적습니다.
  • 저장소 한두 개에서 자동 검토를 켜고(저장소에서 선택한 다음 일정 변경), 이어서 워크스페이스 전체로 넓힙니다.
  • HeyDeer Review 검사를 필수로 지정하고, 자동 승인 사용 여부를 정하고, 유료 요금제라면 자동 충전과 사용량 한도를 설정합니다.

팀이 대부분의 발견 사항에 대응하고 검토가 검토 안내 없이 끝나면 다음 단계로 넘어가세요. 설정은 워크스페이스 관리자가 바꾸며, 쓰기 권한이 있으면 누구나 검토를 요청할 수 있습니다.

자세히 보기: 팀에 도입하기
팀에 공개하기 전에 HeyDeer를 먼저 써 볼 수 있나요?
네. 워크스페이스 설정 → 검토 규칙 → 결과 게시에서 GitHub 검사 게시와 PR에 검토 댓글 게시를 끄세요. 그런 다음 검토 기록 페이지의 검토 시작으로 검토를 요청하고 결과를 그곳에서 확인합니다. 결과는 HeyDeer 안에만 표시됩니다. 검토는 평소처럼 실행되고 크레딧도 사용합니다. 팀과 검토를 공유할 준비가 되면 두 옵션을 다시 켜세요.
자세히 보기: 결과 게시
HeyDeer가 요청을 받았는지 어떻게 알 수 있나요?
HeyDeer는 요청을 받으면 댓글에 👀를 달고, 검토가 끝나면 이를 지운 뒤 풀 리퀘스트에 검토를 게시합니다. 그동안 HeyDeer Review 검사에 검토 진행 상황이 표시됩니다. HeyDeer가 검토를 실행할 수 없거나, 검토가 실패하거나 취소되면 HeyDeer가 댓글에 답글을 답니다. 👀가 달리지 않은 댓글은 명령으로 인식되지 않은 것입니다. 코드, 인용, 수정이 아닌 새 댓글에 일반 텍스트로 작성하세요.
자세히 보기: PR 댓글 명령
검토 결과는 어디서 볼 수 있나요?
풀 리퀘스트에서 볼 수 있습니다. HeyDeer는 발견 사항을 GitHub 검토로 게시하며, 각 발견 사항이 가리키는 줄에 인라인 댓글을 답니다. 변경으로 인해 동작하지 않게 되는 기존 호출부처럼 diff 밖의 코드에 대한 발견 사항은 검토 본문의 추가 발견 사항에 표시됩니다. HeyDeer Review 검사가 결과를 보고하며, 검사의 세부 정보 링크를 누르면 HeyDeer에서 전체 보고서가 열립니다. HeyDeer의 검토 기록 페이지에는 모든 검토가 나열됩니다. 워크스루 버튼을 누르면 관련된 수정을 묶고 중요한 부분을 강조한 변경 가이드가 열려, 다음에 풀 리퀘스트를 읽는 사람에게 도움이 됩니다.
자세히 보기: 검토 결과 읽기
HeyDeer는 코딩 에이전트가 연 풀 리퀘스트도 검토하나요?
네. 코딩 에이전트나 다른 봇이 연 풀 리퀘스트도 다른 풀 리퀘스트와 똑같이 검토합니다. HeyDeer는 각 풀 리퀘스트를 작성한 에이전트와 분리해 따로 검토합니다. 에이전트는 자신의 실수를 놓치기 쉬우므로 이 점이 중요합니다. 이후 푸시에서는 이전 문제를 다시 확인합니다. 기본 자동 검토 필터가 건너뛰는 것은 초안, 포크, 그리고 Dependabot이나 Renovate 같은 봇의 종속성 업데이트뿐입니다. HeyDeer가 승인한 에이전트 풀 리퀘스트를 병합하려면 코드 검토를 하지 않는 팀을 위한 설정을 따르세요.
자세히 보기: 코드 검토가 없는 팀

아직 도움이 필요하신가요?

HeyDeer를 만드는 팀과 채팅하거나 이메일로 문의하세요.

hey@heydeer.ai 문서 보기