코드 리뷰에 의견 작성하는 법

요약

• 친절해라.
• 논증해라.
• 명확한 해법을 제시하는 방법, 또는 문제만 지적하고 작성자가 해법을 선택하게 하는 방법 두 가지를 적절히 사용해라.
• 복잡한 내용이 있다면 설명을 요청하기 보다는 코드를 명료하게 바꾸거나 주석을 작성하도록 해라.

상호 존중

언제나 코드 작성자를 존중하면서 도움을 줘야한다. 작성자가 아니라 코드에 대한 의견을 제시한다.

⛔️ 잘못된 예

병행(concurrency)으로 수행해도 큰 이점이 없는데 왜 쓰레드를 쓰셨어요?

✅ 올바른 예

여기에서는 병렬 구조로 인한 복잡성 대비 성능상 이점이 보이지 않네요. 성능에 크게 차이가 없으니 해당 코드는 단일 쓰레드에서 실행하는게 최선인 것 같습니다.

이유를 설명하기

위의 올바른 예를 보면 듣는 사람이 납득할만한 이유를 제시하고 있다. 모든 댓글에 이유를 달 필요는 없지만 당신의 제안이 어떻게 코드 품질을 개선하는지 설명을 해주면 좋다.

방향 제시하기

최종적으로 CL을 수정할 책임은 작성자한테 있다. 리뷰어가 상세한 설계까지 해줄 의무는 없다. 리뷰어는 본인의 적절한 판단 하에 문제점을 지적하기만 할 수도 있고 좀 더 상세하게 방향을 제시할 수도 있다. 다만 작성자가 해당 코드를 잘 이해하고 있기 때문에 리뷰어보다 더 나은 해답을 찾아낼 수도 있고, 그 과정을 통해 성장할 수도 있다. 하지만 개발자의 성장은 부수적인 것이고, 코드 리뷰의 핵심 목표는 CL을 최선으로 만드는 것이기 때문에 필요에 따라 개입하여 직접적인 대안이나 코드를 제시하도록 한다.

작성자의 설명 받아들이기

리뷰어가 코드를 보고 이해가 안가서 작성자에게 설명을 요청했다면 왠만해선 코드를 더 명확하게 다시 짜야한다. 또한 코드 리뷰 툴에 쓰인 내용은 추후에 코드를 읽는 개발자들에게 도움이 되지 않는다. 따라서 리뷰 툴에 설명을 다는 경우는 코드 관리자들은 알지만 리뷰어만 모르는 내용이 있다던지 하는 경우로 제한되어야 한다.

다음: 반대 의견에 대처하는 방법