빠른 시작

시작하기 전에

• 검토받을 저장소에 쓰기 권한이 있는 GitHub 계정.
• 해당 저장소에 열려 있는 풀 리퀘스트.
• 조직의 경우, HeyDeer GitHub App을 설치하거나 요청을 승인할 수 있는 소유자.

새 워크스페이스는 무료 요금제로 시작합니다. 첫 달은 생성일부터 시작되며 1,000크레딧이 포함됩니다. 이후에는 매월 300크레딧이 포함됩니다. 무료 요금제에서는 각 저장소에서 한 번에 1개의 검토를 실행할 수 있으며 신용카드는 필요하지 않습니다. 크레딧을 모두 사용하면 크레딧을 추가하거나 다음 달 크레딧 지급을 기다리거나 유료 요금제를 선택할 수 있습니다. 요금제 및 추가 크레딧을 참고하세요.

1. 로그인하고 계정 선택하기

GitHub로 로그인하세요. 저장소 연결에서 개인 계정이나 조직을 선택하세요. 목록에 없다면 GitHub에서 설치 또는 다른 계정에 설치를 선택한 다음 GitHub에서 해당 계정을 선택하세요.

2. 저장소 추가

HeyDeer가 저장소를 요청하면 저장소 추가를 선택하세요. GitHub에서 Only select repositories를 선택하고, 검토할 저장소를 고른 다음 확인하세요. HeyDeer가 이미 저장소에 접근할 수 있다면 이 단계는 건너뛰세요.

조직에서는 사용자가 소유자가 아니면 GitHub가 소유자에게 승인을 요청합니다. GitHub App 및 권한을 참고하고, 계정이나 저장소가 보이지 않으면 문제 해결을 참고하세요.

HeyDeer가 저장소에 접근할 수 있게 되면 푸시할 때마다 검토를 시작하고(풀 리퀘스트당 최대 5회) 검토 사용자 지정을 표시합니다. 여기서 다른 일정이나 검토 깊이를 선택하거나, 풀 리퀘스트 자동 검토를 꺼서 요청할 때만 검토하도록 할 수 있습니다. 언제든지 바꿀 수 있습니다. 자동 검토를 참고하세요.

3. 검토 요청하기

풀 리퀘스트에 @heydeer review 댓글을 남기세요. HeyDeer에서 검토를 시작할 수도 있습니다.

👀나 답글이 달리지 않나요? 문제 해결을 참고하세요.

4. GitHub에서 결과 확인하기

HeyDeer는 발견 사항을 검토 댓글로 게시하고, 결과를 HeyDeer Review 검사로 보고합니다. 검사의 Details 링크를 누르면 HeyDeer에서 전체 보고서가 열립니다. 검토 결과 읽기를 참고하세요.

선택한 발견 사항을 HeyDeer가 수정하도록 하려면 검토 댓글에서 HeyDeer로 수정을 선택하세요. HeyDeer가 별도의 PR을 열면 직접 검토하고 병합할 수 있습니다. HeyDeer로 수정을 참고하세요.

다음 단계

• HeyDeer의 검토 시점을 선택하세요. 자동 검토가 아직 꺼져 있다면 워크스페이스 관리자가 워크스페이스 설정 → 검토 규칙 → 검토 시점에서 PR당 한 번 또는 푸시할 때마다를 선택할 수 있습니다. 자동 검토를 참고하세요.
• 팀에 맞는 구성을 선택하세요. 코드 검토가 없는 팀 또는 사람 검토자가 있는 팀을 참고하세요.
• HeyDeer에 코드베이스를 알려주세요. 컨벤션은 AGENTS.md에, 검토 지침은 REVIEW.md에, HeyDeer가 반드시 확인해야 하는 요구 사항은 저장소 검사로 두세요. HeyDeer가 읽는 내용을 참고하세요.