개발자라면 매일같이 하는 것이 코드리뷰를 주고받는 것이다. 이게 개발자 간에 의사소통과도 같기 때문에 작은 스킬 하나로 서로에게 행복을 가져다줄 수도 앙금을 쌓아 갈 수도 있다. 그중 내가 이건 잘하고 있다고 생각되는 팁이 하나 있어서 소개해보려 한다.
코멘트를 모두 적용하라
무슨 소리인고 하니.. 리뷰어가 가장 열받는 상황 중 하나는 자신의 리뷰 코멘트가 무시당했을 때이다. 물론 자신의 의견을 반대하는 경우도 기분이 좋지 않을 수 있겠지만. 이 경우는 다시 반론을 달아 자신의 의견을 다시 한번 피력할 수라도 있는데. 아예 무시당하고 그냥 머지해 버린다거나 하면 내 코멘트 봤냐? 대답해 달라 물어보기도 짜증 나고 다음부터는 코멘트를 달고 싶어지지 않을 수도 있다.
그러므로 어떤 방식으로든 리뷰의 코멘트를 당신의 PR (여러 이름이 있지만 PR로 통일)에 녹여내면 리뷰어도 자신(의 코멘트들)이 존중받는 기분을 선물해 줄 수 있다. 여기에 코멘트들의 종류에 따라 적용하는 방식이 천차만별일 텐데 지금 생각나는 것들만 적어본다.
코드 스타일에 관한 코멘트. 우선 기본적으로 코드 스타일은 linter/formatter에게 맡기는 것이 가장 좋다. 그 설정만 팀이 공동으로 설정하고 linter가 자동으로 고치도록 해야 서로 왈가왈부할 필요가 없어진다. 그렇지만 만약 linter가 커버하지 못하는 영역의 스타일을 통일하고 싶다면 스타일 가이드 문서를 만들어 놔야 할 것이다. 즉, 리뷰어의 스타일 코멘트가 오면 거기에 맞게 코드를 고치고 이를 스타일 가이드 문서에 업데이트하는 것이 좋다. 그리고 리플에 이 업데이트 사실을 알린다. 그럼 모두가 해피.
단순 질문. 당신의 코드에 태클은 아니지만 왜 이렇게 했는지 질문자원의 코멘트가 있을 수 있다. 이경우 당신의 코드가 직관적이지 못하거나 그냥 리뷰어가 잘 모르는 등 다양한 경우가 있을 수 있다. 그렇지만 어떠한 이유로든 당신의 코드를 다른 사람이 봤을 때 이해가 가지 않는 부분이 있다는 뜻이므로, 리플로 질문에 대한 대답을 하고 코드에도 간단한 주석을 삽입하면 좋다. 이렇게 하면 그 질문자도 나중에 코드만 보더라도 이해할 수 있고 또 같은 질문이 올라오는 것을 방지할 수도 있다.
어.. 이상하다 종류가 더 있었던 것 같은데.. 일단 푸시하고 생각나면 더 적겠습니다..