코드리뷰에 관한 정리

코드리뷰란?

한 명 또는 여러 명의 개발자가 본인이 만들지 않은 코드의 내용을 점검하고, 피드백을 주는 과정. 단순히 문제를 파악하는데 그치지 않고 코드에 대한 책임이 그 코드를 만든 사람 혼자에게 있지 않고 우리 모두에게 있다는 문화는 만드는데 있다.

 

왜 해야할까?

• 소프트웨어의 품질 유지
• 개발자의 작업 내용을 이해
• 다른 사람의 잘 만들어진 소스를 보면서 배울 기회를 얻음.

누구에게 리뷰를 부탁해야할까?

• Senior
  • 내 코드를 점검 및 피드백 받을 수 있는 기회.
• Junior
  • Senior의 코드를 리뷰하면서 배울 기회를 얻음.

 

언제 해야할까?

• 실리콘 밸리의 큰 회사들(구글, 페이스북)은 코드리뷰 요청이 오면 업무의 최우선순위로 조정되어 즉시 응답하도록 하는 것이 원칙이라고 함.
• 토스팀의 경우, [월 ~ 수]: 기존 개발 업무 우선, [목, 금]: 코드리뷰 최우선, 단, 목요일 출근전까지 리뷰 요청을 한 건을 대상으으로 한다고 함.
• 긴급한 건은 예외

 

어떻게 해야할까?

• 개발자
  • 코드 리뷰는 1시간 이내에 끝낼 분량
  • 코드는 500라인 이하
• 리뷰어
  • 상대방을 공격하지 않는 느낌을 줘야한다.
  • 문제를 이슈업하기보다는 대안을 제시
  • 문제의 검출과 해결에 주안을 둔다.

참고:

https://velog.io/@zetlos/%EC%86%8C%EC%8A%A4%EC%BD%94%EB%93%9C-%EB%A6%AC%EB%B7%B0%EC%97%90-%EB%8C%80%ED%95%9C-%EC%A7%A7%EC%9D%80-%EC%9D%B4%EC%95%BC%EA%B8%B0

 

https://tosslab.github.io/codereview/2015/12/18/%EC%BD%94%EB%93%9C%EB%A6%AC%EB%B7%B0-%EC%9D%B4%EB%A0%87%EA%B2%8C-%ED%95%98%EA%B3%A0-%EC%9E%88%EB%8B%A4.html#3.-%EC%BD%94%EB%93%9C%EB%A6%AC%EB%B7%B0%EB%8A%94-%EC%96%B8%EC%A0%9C-%ED%95%98%EB%82%98%EC%9A%94

 

https://blog.logi-spot.com/%EC%BD%94%EB%93%9C%EB%A6%AC%EB%B7%B0%EC%9D%98-%EC%A7%84%EC%A7%9C-%EB%AA%A9%EC%A0%81%EC%9D%80-%EB%94%B0%EB%A1%9C%EC%9E%88%EB%8B%A4/

---

위 내용을 바탕으로 우리 팀에서는 나름대로의 코드리뷰의 규칙을 정했습니다.

 

누구에게 리뷰를 보낼까?

• 가장 적합한 자 1명(정)
• 아무나 1명(부) 

언제 보낼까?

• 화, 목: 코드리뷰가 최우선 순위
• 화요일 출근전까지 온 리뷰는 화요일에 완료할 것. 목요일 출근전까지 온 리뷰는 목요일에 완료하는 것이 규칙.
• 긴급하게 당일 리뷰가 되어야하는 경우, Scrum 시간에 알릴 것.

어떻게 보내야할까?

• 리뷰어가 1시간 이내에 리뷰할 수 있는 분량
• 기본적으로 task 단위, 최대 sprint 단위
• 개발자 테스트 자료 함께 전달