검토 결과 읽기
GitHub와 HeyDeer에서 HeyDeer 검토의 각 부분이 무엇을 의미하는지 알아보세요.
HeyDeer가 게시하는 내용
HeyDeer는 발견 사항을 GitHub 풀 리퀘스트 검토로 게시하며, 각 발견 사항이 가리키는 줄에 인라인 댓글을 답니다.
검토 본문은 결과로 시작하며, 아직 처리가 필요한 이전 문제의 링크를 보여 줍니다. 마지막에는 접힌 이 검토 정보 섹션이 있으며 검토 요약, 위험 수준, 검토 깊이, 시작 방법, HeyDeer에서 보기 링크와 설정 링크가 포함됩니다.
본문에는 검토 안내, 추가 설명 필요 아래의 질문, 인라인으로 달 수 없는 발견 사항도 들어갑니다. GitHub는 diff에 포함된 줄에만 인라인 댓글을 허용하므로, 변경으로 인해 깨지는 변경되지 않은 호출부처럼 다른 코드에 대한 발견 사항은 추가 발견 사항 아래에 표시됩니다.
전체 보고서는 HeyDeer Review 검사와 HeyDeer의 검토 페이지에서 볼 수 있습니다. 검토가 너무 길어 GitHub 댓글 하나에 담기지 않으면 나머지 내용은 전체 보고서에 있습니다.
HeyDeer는 자동 승인이 켜져 있을 때만 풀 리퀘스트를 승인합니다.
PR에 검토 댓글 게시가 꺼져 있으면 검사에만 검토가 담깁니다. 결과 게시를 참고하세요.
HeyDeer는 게시하는 모든 내용을 저장소의 검토 언어로 작성합니다.
발견 사항의 구성
| 부분 | 표시 내용 |
|---|---|
| 제목 | 심각도, 카테고리, 제목. 예: “🟠 높음 (신뢰성): 404 응답에서 재시도 루프가 멈추지 않음”. |
| 설명 | 무엇이 잘못되었고 어떤 결과를 낳는지. |
| 변경 제안 | 댓글이 대체할 줄에 달려 있을 때 표시되는, 바로 커밋할 수 있는 정확한 수정. |
| 자세히 알아보기 | 접힌 영역: 원인, 수정 제안, 여기서 커밋할 수 없는 변경의 읽기 전용 diff, 이를 발견한 저장소 검사. |
| 관련 코드 | 댓글이 해당 줄에 달리지 않은 경우, 그 줄로 가는 링크. |
심각도(치명적, 높음, 보통, 낮음)는 발견 사항의 영향을 나타냅니다. 이는 HeyDeer가 발견 사항이 실제 문제라고 얼마나 확신하는지를 나타내는 확신도와는 별개입니다. 게시할 발견 사항을 줄이거나 늘리려면 두 가지를 함께 고려하는 피드백 범위를 변경하세요.
HeyDeer가 별도 PR에서 변경 사항을 작성하게 하고 이를 직접 검토해 병합하려면 HeyDeer로 수정을 사용하세요.
카테고리
카테고리는 발견 사항이 무엇을 해치는지를 나타내며 심각도와는 별개입니다. 여러 개에 해당하면 HeyDeer는 이 표에서 먼저 해당하는 것을 고릅니다.
| 카테고리 | 해치는 것 |
|---|---|
| 보안 | 누군가 해서는 안 되는 일을 하거나 봐서는 안 되는 것을 볼 수 있습니다. |
| 정확성 | 정상적인 사용에서 잘못된 결과가 나옵니다. |
| 신뢰성 | 오류, 동시성, 부하, 재시도 또는 부분 장애 상황에서 실패합니다. |
| 성능 | 시간이나 리소스를 너무 많이 사용합니다. |
| 유지보수성 | 실패하지는 않지만 코드를 변경, 테스트하거나 읽기가 더 어려워집니다. |
검토 안내
검토에 제약이 있었던 경우, HeyDeer는 검토 본문의 검토 안내 아래, 검사 요약, 검토 페이지에서 그 내용을 설명합니다.
| 검토 안내 | 조치 방법 |
|---|---|
| 일부 발견 사항이 생략되었습니다 | 검토는 확신도와 심각도에 따라 우선순위가 가장 높은 발견 사항만 유지합니다. 표시된 발견 사항을 수정하거나 처리하지 않기로 결정한 다음 검토를 다시 요청하세요. |
| 일치하는 저장소 검사가 너무 많습니다 | HeyDeer는 일치하는 검사를 파일 이름 순서로 적용하고 나머지는 건너뜁니다. 파일 패턴을 좁힌 다음 검토를 다시 요청하세요. |
| 일부 저장소 검사가 유효하지 않습니다 | HeyDeer는 유효하지 않은 검사를 건너뛰고 그 이름을 알려 줍니다. 수정한 다음 검토를 다시 요청하세요. |
| 일부 저장소 검사를 완료하지 못했습니다 | 검토를 다시 요청하세요. |
| 일부 발견 사항 또는 이전 문제를 충분히 평가하지 못했습니다 | 완전한 결과를 받으려면 검토를 다시 요청하세요. |
검토 안내가 있는 검토는 완료되지 않은 것으로 간주되므로, HeyDeer는 이를 승인하지 않으며 해당 검사도 성공을 보고하지 않습니다.
검토 안내에 대한 추가 도움말은 문제 해결을 참고하세요.
워크스루
GitHub의 검토에는 HeyDeer로 수정 옆에 워크스루 버튼이 있습니다. 누르면 HeyDeer에서 워크스루가 열리며, 관련 변경 사항을 묶고 중요한 변경 사항을 강조해 보여 줍니다. 각 그룹은 무엇을 확인할지 알려 주고, 검토한 커밋 기준의 코드를 보여 줍니다.
관련된 그룹은 같은 탭에 모입니다. 브라우저, 서버, 데이터베이스처럼 시스템의 여러 부분에 걸친 변경을 담은 탭은 다이어그램으로 시작합니다. 다이어그램은 그 부분들이 어떻게 연결되는지, 또는 그 사이의 단계를 순서대로 보여 줍니다. 다이어그램을 선택하면 확대됩니다.
각 그룹에는 필독, 읽기 권장, 훑어보기 중 하나가 표시됩니다. 테스트, 문서, 반복적인 수정처럼 주요 흐름에서 벗어난 변경 사항은 이유와 함께 기타 아래에 나열됩니다. 검토가 건너뛴 생성 파일은 기타 끝에 표시되고, 같은 PR의 후속 검토는 마지막 검토 이후 변경된 그룹을 표시합니다.
워크스루는 변경 사항을 설명하는 것이지 발견 사항 목록이 아닙니다. HeyDeer의 검토 페이지에서도 워크스루로 열 수 있습니다. 검토 규칙의 워크스루에서 끌 수 있습니다.
파일의 확인함에 체크하면 접힙니다. 파일의 모든 부분에 체크하면 HeyDeer가 GitHub에서도 그 파일을 확인한 것으로 표시합니다. 파일이 바뀌면 GitHub가 그 표시를 해제합니다.
HeyDeer의 검토 페이지
모든 검토에는 HeyDeer 페이지가 있습니다. 검토 기록, 검사의 Details 링크, 또는 검토 본문의 HeyDeer에서 보기에서 열 수 있습니다.
검토 페이지에는 시작 방법과 검토가 새 변경 사항을 다뤘는지 PR 전체를 다뤘는지가 표시됩니다. 또한 피드백 범위 안의 모든 발견 사항과 논의에서 처리하지 않기로 한 우려 사항 아래의 우려 사항도 나열됩니다.
검토가 실행되는 동안 검토 진행 상황에 단계와 각 검토자가 하는 일이 표시됩니다. 검토가 끝나면 접혀 있는 검토 과정 패널에 각 단계, 검토에 걸린 시간, 각 검토자가 한 일이 남습니다.
다른 피드백 범위에서 유지될 발견 사항이 다르면 아무것도 변경하지 않고 미리 볼 수 있습니다. 발견 사항 옆에서 범위를 선택하거나, 발견 사항이 없는 결과 아래에서 미리 보기를 선택하세요. 쓰기 권한이 있는 사람은 검토 취소로 검토를 중지할 수 있으며, 이미 사용한 크레딧은 반환되지 않습니다.