목차
1.
3.
결론
서론
•
코드리뷰는 커뮤니케이션 도구, 리뷰어도 코드 작성자도 상대방을 배려해야 한다.
•
주니어도 시니어의 코드리뷰를 하며 질문, 승인 등의 행위를 해야한다.
•
코드리뷰에선 승인한다는 것이 모든 책임을 지는 것은 아니다. 부담가질 필요가 없다.
본론
코드 리뷰 기본 원칙
•
모든 코드는 코드 리뷰를 마친 후에 머지하는 것을 원칙으로 한다.
•
혼자가 아닌 함께 하는 일이기에 코드 리뷰에 책임감을 가져야 한다.
•
최소 2명을 필수 리뷰어(assigner)로 팀은 리뷰어(reviewer)로 지정한다.
•
최소 2명의 리뷰어가 PR을 승인해야 머지할 수 있다.
•
인프라 작업이나 릴리즈 PR은 리뷰를 생략할 수 있으며 단 review skip 레이블을 붙여, 공통 리뷰 시간을 정해 일괄 검토한다.
•
PR을 받았다면 하루 안에 답변을 하고, 답변이 없다면 재촉한다.
•
특별히 주의가 필요한 리뷰 포인트는 코멘트를 직접 작성한다.
•
자신의 취향을 강요하기보단 사실과 데이터를 가지고 의견을 남긴다.
코드 리뷰를 요청할 때 지켜야할 매너
1. 변경한 내용에 대한 충분한 정보를 제공하기
•
커밋 메시지 충실하게 작성하기
: 제목에 간략히 작업 내용을 요약해서 적고 상세 내용을 본문에 작성한다.
•
PR 본문을 충실하게 작성하기
: PR의 본문에도 PR을 작성한 계기, 수정 방향, 관련 이슈 등을 충실하게 작성해야 한다.
2. 작은 PR 만들기
•
작은 PR의 조건
: 하나의 PR에는 하나의 작업만 담겨 있어야 함, 하나의 PR에 여러 작업이 포함되면 리뷰를 하기가 어려워진다.
코드 리뷰를 할 때 주의할 점
1. 코드 리뷰를 할 때 보아야 할 것 - 체크리스트
체크리스트
2. 리뷰중인 코드 보는 법
•
코드 리뷰는 다음과 같은 단계로
◦
전체 코드를 훑어보기
▪
코드 전체에서 일어나는 변경을 가볍게 훑어보기
▪
의미가 없는 변경점이나 변경이 일어나서는 안 되는 곳이 있는지 확인
◦
PR의 주안점 확인
▪
리뷰를 받는 사람이 제시한 주요 변경사항을 확인
▪
구조를 변경한 PR은 빠르게 피드백을 전달하고 동료에게 전파
◦
놓치는 파일이 없도록 모든 부분을 꼼꼼하게
3. 언제 코드 리뷰를 하면 좋을까
•
코드 리뷰는 요청을 받는 즉시 하는 것이 원칙으로
•
자리에 앉아서 다른 업무를 시작하기 전에 코드 리뷰를 하는 습관을 들이자
◦
출근 직후
◦
점심 먹고 자리에 앉았을 때
◦
회의나 화장실에 갔다가 돌아와서 업무를 시작하기 전에
