코드 리뷰 문화

💎 코드 리뷰 컨벤션

코드 리뷰 기본 원칙

• 모든 코드는 코드 리뷰를 마친 후에 merge 한다.
• 최소 2명을 리뷰어로 지정하고, 그 2명이 모두 PR을 승인해야 merge할 수 있다.
• infra 작업은 리뷰를 생략할 수 있다.
• PR 리뷰 요청을 받았으면 그로부터 24시간 내에 답변을 준다. 답변이 없으면 재촉한다.
• 리뷰하기에 양이 많다면 오프라인 혹은 줌 회의 리뷰를 요청한다.
• 코드 작성자는 특별히 신경 써야 할 리뷰 포인트가 있다면 files changed의 해당 부분에 코멘트를 남긴다.
• 자신의 취향을 주장하기 보다는 사실과 데이터를 가지고 의견을 교환한다.

코드 리뷰를 요청할 때 지켜야 할 기본적인 매너

• 커밋 메시지 충실히 작성하기
• PR 본문을 충실히 작성하기
• PR을 최대한 작게 만들기
  • 변경한 코드의 양이 적을수록 리뷰하기가 쉽고 버그가 있을 가능성이 낮을 분 아니라 피드백을 적용하기 더 쉽다.
  • 하나의 PR에는 하나의 작업만!
  • 새로운 함수나 API를 추가할 때는 해당 API 혹은 함수를 사용하는 코드도 PR에 포함시킨다.

코드 리뷰를 할 때 주의할 점

• 코드 리뷰는 생성된 pull request에서 리뷰어로 설정된 경우 진행한다.
• 먼저 해당 branch를 내 로컬로 pull한 후 실제 Unity Editor를 켜고, play하며 무엇이 바뀌었는지 확인한다.
  • 이 때 해당 pull request의 files changed를 보면 수정된 사항을 알 수 있다.
• 코드에 대한 리뷰는 files changed의 해당 코드 부분에 comment로, .unity 파일과 같이 Unity Editor에서만 확인할 수 있는 사항들에 대한 리뷰는 pull request의 comment로 작성한다.