저자는 풀 리퀘스트(PR)를 검토하는 자신만의 체계적인 접근 방식을 5W1H(When, What, Why, Who, Where, How) 프레임워크를 통해 제시합니다.
1. PR 검토의 맥락 및 준비
-
검토 시점: 하루 중 개인 작업 흐름을 방해하지 않는 유연한 시간을 활용합니다.
-
목적과 동기: PR의 목적(병합/피드백)과 검토자의 동기(전문성/학습)를 명확히 하고, 작성자의 스타일과 잠재적 독자를 고려합니다.
-
초기 파악: PR 제목과 설명을 통해 변경 이유와 주요 관심사를 파악하고, 커밋 목록으로 작업 구조를 이해합니다. 기존 코멘트는 검토 직전까지 확인하지 않습니다.
2. PR 코드 검토 방법론
-
전체 스캔: 파일 변경 사항을 읽기 전에 스크롤하여 전체 모양, 파일 이름, 작업 비중을 파악합니다.
-
테스트 우선 검토: 특히 Ruby 프로젝트에서는
test또는spec디렉토리의 테스트 코드를 먼저 읽어 구현 의도와 중요 부분을 파악합니다. 이를 통해 복잡한 설정이나 과도한 목킹 등 잠재적 논의 지점을 쉽게 식별합니다. -
구현 상세 검토: 테스트 정보를 바탕으로 구현 코드를 상세히 검토하며, 일반적으로 알파벳 순서로 진행합니다.
-
최종 점검: 모든 변경 사항 검토 후, 설명을 다시 확인하여 목표 달성 여부를 검토하고, 전체 구조와 디자인 패턴을 고려하여 최종적으로 훑어봅니다.
이러한 단계적 접근은 PR의 맥락을 이해하고, 효율적이며 심층적인 코드 리뷰를 가능하게 합니다.