정기간행물/daily

우리 팀의 코드 품질 향상을 위한 Code Review - 홍승환

:)jun 2023. 9. 1. 18:24
  1. 코드 리뷰의 도입이 힘든 이유
    1. 그럴 시간 없다
    2. 좋은게 좋은거지
    3. 비난이나 공격
  2. 코드 리뷰 왜 해야지?
    1. 제품 품질 - 잠재 오류를 사전에 발견
    2. Bus Factor 최소화 - context sharing을 통한 엔지니어 가담 가능성 상승
    3. 업무 효율화 - 서로 다른 코딩 컨벤션부터 전반적인 설계 원칙까지 점직적으로 싱크

두 가지 방향에서의 노력 (받는 사람, 하는 사람의 노력)

  • 받는 사람
    • Git을 똑바로 사용하자.
    • 리뷰 받을 준비가 된 PR을 만들자.
      • CI 파이프라인이 통과됐는가?
        • Formatter, Type checker, unit test
      • 리뷰 가능한 크기인가?
      • 적절한 리뷰어 설정했는가?
        • 개인별 reviewer 지정
        • Team Reviewer 지정
        • Branch Protection Rule
        • Code Owner
      • self-review 마쳤는가?
        • 리뷰 보내기 전에 내가 먼저 리뷰하자
  • 하는 사람
    • 모든 것이 리뷰의 대상이다.
      • 전반적인 로직 구성과 대안 검토, 추후에 풀고자 하는 문제에 대한 고민도 해야한다.
    • 리뷰를 두려워하지 말자.
      • 솔직하게 이야기하고 건강하게 충돌하자.
      • 사람이 아닌 코드와 현상을 비판한다는 합의를 전제한다.
    • 항상 상대방을 존중하고, 좋은 부분은 칭찬하자.
      • 지적 사항이 없을 때도 괜히 찾아서 쓰려고 하지는 말자.
      • 서로 존중하고 칭찬하는 문화를 유지하자.