본문 바로가기
개발 메모

효과적인 코드 리뷰를 위해서

by Whiimsy 2024. 8. 8.

https://engineering.linecorp.com/ko/blog/effective-codereview#enhance-skill

 

효과적인 코드 리뷰를 위해서

종종 팀 내에서 코드 품질이 이슈가 됩니다. 그리고 유닛 테스트와 코드 커버리지를 향상시키는 방법에 대해 모두가 한 마디씩 던집니다. 하지만 그리 오래가진 못합니다. 모두들 다시 바빠지면

engineering.linecorp.com

 

코드 리뷰 프로세스를 효율적으로 하기 위해서

  • 리뷰어를 희귀한 자원으로 다루는 것이 중요하다

코드 리뷰 목표

  • 변화를 작게 유지하자
  • 리뷰는 자주 짧은 세션으로 진행하자
  • 리뷰를 위해 최대한 빨리 PR을 보내자
  • 의미 있는 PR을 만들기에 충분한 정보를 제공하자
  • 코드 분석툴을 활용하고 코드 스타일을 확인하자
1시간에 300줄 정도 리뷰하는 것이 적당

PR 내용엔

  • 무슨 이유로 어떻게 코드를 변경했는지
  • 어떤 위험이나 우려가 발견되었는지
  • 무엇을 완료하여 테스트했고
  • 어떤 부분에 리뷰어가 집중해야 하는지

가 명확하게 담겨 있어야 한다

PR 템플릿 예시

  1. Why need this change? / Root case:
  2. Changes made:
  3. Test Scope / Change impact:
  4. Veriried Screenshots (optional)
코드 리뷰에서 중요한 부분 중 하나는 개발자들의 성장과 노력에 대해 보상하는 것. 최대한 많이 칭찬~

'개발 메모' 카테고리의 다른 글

내 코드 컨벤션  (0) 2022.05.24