Code Review

Code Review

기존 Github Pull Request 방식

• feature 브랜치는 2명 이상의 승인을 받아야 main 브랜치로 merge 가능하게 하였다.
• 목적은 코드 품질 향상에 있었기 때문에, 특정 인원을 지목하지 않고 누구든 리뷰할 수 있게 하였다.
• 원격 비동기식 방식 (remote, asynchronous).

문제점

• 코드 리뷰에서 자동화할 사항을 정하지 않았다.
• 코드 리뷰에 자유성이 높아, 시간이 지날수록 리뷰 참여 인원이 줄어듦.
• PR 승인까지 시간이 오래 걸림, 병합 지연 발생.

해결 방안

• 자동화 가능한 부분 추가

  • 정적 코드 분석: IntelliJ Plugin인 SonarLint를 사용.
  • 코드 포맷 정렬: IntelliJ 자동 정렬 기능 사용, Google Java Style 기반 코드 스타일.
  • PR 전 체크: PR을 올리기 전에 정적 코드 분석과 코드 포맷 확인.
  • PR에서는 자동화로 해결된 부분에 대한 리뷰 생략.

• 코드 리뷰에 규칙 추가

  • 모든 팀원이 하나 이상의 코멘트 달기 (좋은 점, 개선할 점, 새로 알게 된 점 등).
    • PR을 모든 팀원이 확인하게 하기 위함.
  • 담당 리뷰어 지정:
    • 인당 한 명의 리뷰어를 지정, PR 생성 시 해당 리뷰어에게 승인 요청.
    • 리뷰 요청 후 24시간 내에 리뷰를 완료.