코드리뷰는 지적 하기 위함이 아닌 “코드 품질을 개선”하기 위한 행위이다!!
코드리뷰 방법
- 원칙에 기반하여 피드백하도록 노력하기
- 개선점이 보이면 이유와 방향 제시하기
- 좋은 아이디어는 꼭 칭찬해주기!
- 필수 반영사항이 아닌 코멘트일 경우
Nit(사소한것) 로 표기 - 한꺼번에 많은 코멘트로 공격x
- 하이레벨(기본 기능 동작 여부, 전체 코드의 설계방식 개선의견, 복잡한 함수의 분리)
→ 로우레벨(UI, 변수명 변경, 주석필요여부, 컨벤션 등등) - 하이레벨 코멘트 먼저 등록 후 로우래벨 코멘트 등록하는 순으로 진행
- 핵심 부분의 설계가 잘못되었다면, 나버지 코드를 보기 전에 즉시 공유!
- 하이레벨(기본 기능 동작 여부, 전체 코드의 설계방식 개선의견, 복잡한 함수의 분리)
승인 시점
- 사소한 이슈만 남았다면 승인하기 (master가 아닌 브랜치일 경우)
- 변수명 변경, 오타
- 선택적 제안 코멘트
- hofix 라벨이 붙었을경우에는 바로 승인하되, 테스트 및 코드 확인은 꼭하기!
- 기존 코드에 영향을 주는 코드는 어떤 경우에도 허용되면 안된다고 생각
리뷰하기 좋은 pr 디스크립션 작성하기
- 작업 상세 내용과, 코어 파일 경로 명시
- 필요하다면 코멘트로 대체해도 좋음
코드리뷰 속도
- 가능한 리뷰 요청을 받자마자 한다.
- 업무일 기준 하루를 넘지 않는다.
- 시간이 오래 걸릴 경우 작성자에게 공유한다
- 추후 반영할 사항은 위키 추후 개선할 작업 리스트에 작성해두기
용어정리
- CL : changelist
- LGTM : Looks Good To Me
- Nit: nitpick, 사소한것
참고
항상 질문하는 개발자가 되고 싶습니다✋