코드리뷰 피라미드

Gunnar Morling 블로그의 글 "The Code Review Pyramid"를 번역한 글입니다.

코드리뷰를 하다보면 코드 포맷팅이나 코드 스타일같은 얘기가 다른 중요한 측면(코드가 해야 할 역할을 제대로 하고 있는지, 효율적으로 동작하는지, 이전에 사용하던 클라이언트를 위한 호환성을 갖고 있는지 등)보다 훨씬 더 많은 주목을 받는 경우가 많습니다.

사람들이 이 문제를 깨닫고 어떤 점에 더 신경써야하는지 알리기 위해서 작은 이미지 하나를 트위터에 공유한 적이 있습니다. (주관적인 견해지만) 코드리뷰를 하면서 어떤 점에 좀 더 집중해야하고, 어떤 부분이 자동화되어야하는지를 보여주는 이미지입니다.

이 이미지를 두고두고 보거나 고해상도 버전을 원하는 분들이 계셔서 다시 한번 공유합니다.

원본 이미지 다운로드 링크(.svg)

FAQ

• 왜 피라미드 모양이죠?
  • 피라미드의 아래쪽 부분은 코드리뷰의 기초가 되면서도 코드리뷰의 대부분을 차지해야하기 때문입니다.
• 그냥 삼각형 모양이잖아요?
  • 그렇게 생각할 수도 있겠지만, 측면에서 바라본 피라미드입니다.
• 이미지 만들 때 어떤 툴을 사용했나요?
  • Excalidraw.

인상 깊었던 댓글

mcandre: 테스트를 잘 적어놓으면 문서화가 필요없음. (...) 나였으면 문서화보단 테스트코드 설계, 검증, 퍼징 테스팅, 뮤테이션 테스팅, 유닛 테스팅, 통합 테스팅 순서대로 적었을 듯. (...) 함수 시그니처, 변수 이름도 한번 잘 정해놓으면 굳이 문서화할 필요가 없음. (...) 좋은 프로덕트는 문서화가 거의 필요없음.

maxandersen: 나도 처음에는 이 사람처럼 테스팅을 문서화 밑에다 놓는 그림을 생각했는데... 그림 왼쪽에 바꾸기 쉬운/어려운 부분을 보니까 이해됨. 한번 적어놓은 문서가 테스트보다 시간이 지남에 따라 발전하기가 더 어렵기 때문에 문서가 명확하고 간결해지도록 리뷰하는게 합리적임.