리뷰 방식

리뷰의 목적

• 코드의 품질을 유지
• 모두의 성장

리뷰 조건

• 최소 2명 이상 Approve
• 자기 PR을 올렸을 때, 다른 사람 PR이 올라와 있으면 리뷰를 달고 코드를 작성하기
• 하루 코딩 시작 전, 리뷰 달고 시작하기

리뷰시 확인사항

• 일관성 : 아키텍처(구조)나 컨벤션이 일관성을 유지하는지 확인
• 성능 개선 개발 : 시간복잡도, 메모리
• 오류 : 잠재적인 오류에 대한 검출
• 신규 기술 도입 : 해당 기술의 로직과 그에 대한 물음
• 기술 공유 : 기술적인 지식 공유. 블로그, 라이브러리 링크 제공해주면 좋음
• 기타 : 전체적인 흐름을 이해하기 위해 실제 빌드를 해서 동작을 시켜보고 이해하기도 합니다.
• PN + Q 룰
  • P1: 꼭 반영해주세요 (Request changes)
  • P2: 적극적으로 고려해주세요 (Request changes)
  • P3: 웬만하면 반영해 주세요 (Comment)
  • P4: 반영해도 좋고 넘어가도 좋습니다 (Approve)
  • P5: 그냥 사소한 의견입니다 (Approve)
  • Q : 궁긍한 사항에 대해 질문

코멘트 작성 요령

권고사항

• 가급적이면 대안을 제시할 것
  • OO → XX
  • XX 는 OO 부분을 참고
  • OO → XX 에 의해서 문제
• 방식보다는 내용에 집중하기
  • P5 레퍼런스 참고 : ~~~

ex)

• P1: 충돌 발생

마음가짐

• 내 PR에 리뷰가 많이 달렸다고 상처받지 말자. 그만큼 내 코드를 꼼꼼히 봐줬다는 뜻! 더 빠르게 성장할 수 있는 기회니까 오히려 좋아~
• 리뷰 말투에 상처받지 말자. 아무래도 텍스트로 전달하다 보니 감정을 전달하기 힘들다. 우리 모두 한 팀이고 같은 목표를 가지고 있다는 것을 잊지말자!

버전

버전	날짜	업데이트 내용	상세 내용
1.0	11 / 10	초안
1.1	11 / 20	PN룰에 Q 추가	궁금한 사항 질문할 때 쓸 Q 추가

참고

• 승민’s brain

• 뱅크 샐러드 코드리뷰 방식

  https://blog.banksalad.com/tech/banksalad-code-review-culture/

• 토스 안드로이드 팀

  https://www.theteams.kr/teams/859/post/64467

• 구글 코드리뷰 가이드 (영문)

  https://google.github.io/eng-practices/review/