구글의 코드 리뷰 가이드

이 문서는 구글의 Engineering Practices Documentation의 일부분인 Code Review Developer Guide의 요약 번역본입니다. 원문에서 볼드체와 이탤릭체로 강조한 내용은 거의 다 담고 있으며 구글의 경험이 담긴 내용 또한 빠짐없이 담고자 했습니다.

용어 정의

• CL: “changelist”의 약어. 소스 코드 관리(version control)에 반영되었거나 리뷰를 받고 있는 코드 집합체 단위.
• LGTM: “Looks Good To Me”의 약어. 리뷰를 통과시킬 때 리뷰어가 남기는 말이다.

역주: 그 외 자주 등장하는 단어들은 아래와 같이 통일해서 사용했습니다.

• CL author: 작성자
• Reviewer: 리뷰어
• Code health: 코드 품질

소개

이 문서는 구글의 개발자들이 코드 리뷰를 하는 과정과 지켜야 하는 원칙을 담고 있다. 크게 두 파트로 나눌 수 있다.

• 코드를 리뷰하는 방법: 코드 리뷰어를 위한 가이드
• CL 작성자용 가이드: 리뷰를 받는 코드 작성자를 위한 가이드

적합한 리뷰어 고르기

당신의 코드를 빈틈없이 리뷰해 줄 수 있는 사람이 적합한 리뷰어다. 보통 원래 코드의 주인이 유력하다. 때로는 CL의 각 부분을 다른 리뷰어에게 맡겨야할 수도 있다. 적합한 리뷰어를 찾았지만 리뷰를 해줄 수 없는 상황인 경우는 최소한 참조(CC)에 포함한다.

대면 리뷰

좋은 코드 리뷰를 해줄 자격이 있는 사람이랑 페어 프로그래밍을 했다면 해당 코드는 리뷰를 받은 것으로 간주한다. 대면 리뷰를 진행할 수도 있는데 이 경우에는 리뷰어가 질문을 하고 작성자는 질문을 받았을 때만 발언을 할 수 있다.