[etc] 코드 리뷰

코드리뷰를 하는 이유

• 코드리뷰란, 한명 이상의 사람이 소스코드를 확인하는 소프트웨어 품질 보증 활동이다.

• 코드 리뷰를 부르는 용어는 여러가지가 존재한다.(peer review, pull-request, merge-request)

• 코드리뷰를 하는 목적
  • 품질 문제 검수(버그, 장애)
  • 아키텍처 속성 속성 개선을 위한 코드 개선
  • 코드, 해결책 등과 관련된 지식 공유에 기여
• 내가 알고있는 것을 주변 동료들과 공유하기 쉬운 방법이 ‘코드리뷰’이다.

효율적인 리뷰 방법

• 리뷰는 즉시 시작한다. 저자는 리뷰가 종료될 때까지 대기를 해야하기 때문이다.
• 처음에는 고수준 피드백을 남기다가 점점 저수준 피드백을 남겨나간다.
• 예제 코드를 제공한다.

피드백 방법

• 상대방을 존중할 것. 절대 ‘너’라는 표현은 사용 금지.
• 비판의 대상은 ‘코드’이지 ‘저자’가 아니다.
• 팀의 생산성을 높이기 위한 건설적인 피드백을 하려 노력한다.
• 피드백은 명령이 아니라 요청으로 표현한다.

코드 리뷰 체크리스트

• 버그/장애
• 기능성(구현한 기능)
• 가독성/ 유지보수 용이성 (코드)
• 테스트
• 자료구조
• 성능
• 보안
• 설계(디자인 패턴 등)