코드리뷰 가이드
좋은 리뷰 문화를 위한 약속
2021년 12월 현재, 우리팀은 PR 에 대해 전체 팀원이 승인 후 머지하는 원칙을 지키고 있다. 리뷰를 하다보면 팀원들 간에 암묵적으로 합의하고 있는 규칙도 있고, 각자가 중요하게 생각하는 지점이 달라서 매 리뷰마다 비슷한 논의를 거치게 되는 애매한 부분들도 있다. 그래서 현재 우리가 하고있는 리뷰방식을 바탕으로 리뷰 가이드를 명문화시키면 좋겠다고 생각했다. 그동안 인터넷에서 종종 읽었던 코드리뷰 원칙들은, 이번에 찾아보니 구글의 리뷰가이드에서 기인한 부분들이 많았다. 왠지 익숙한 인간친화적인 말투라고 느꼈었는데, 알고보니 구글 문체였다...! (<- 하루 중 크롬 브라우저 및 지메일에서 10시간 이상 보내는 사람)
기본 가이드를 만드는 것은 우리팀의 리뷰 품질 향상에도 도움이 되지만, 나 스스로에게도 도움이 될 것 같다. 왜냐하면 앞으로 개발을 하면서 새로운 팀원들을 만날 때 개발문화에 대해 이야기를 나누게 될 텐데, 코드리뷰에 대한 이야기를 나눌 때 시작점이 될 수 있는 러프한 가이드문서가 있으면 거기에서 더하거나 빼면서 디벨롭하기 수월할 것 같기 때문이다.
다음은 좋은 코드리뷰 가이드라고 생각하는 글들을 참고하여 직접 작성해본 가이드이다. 리뷰문화는 팀원들과의 합의에 따라 디테일한 부분에서 차이가 발생한다고 생각하기 때문에, 가이드 문서에는 논의의 시작점 역할만 해줄 수 있도록 세세한 규칙은 적지 않았다.
https://gist.github.com/yeonwooz/e075ca2faaaf5fc0cbc52970d60576f3
Photo by Markus Spiske on Unsplash
