좋은 코드 리뷰 나쁜 코드 리뷰 - 19가지 사례와 33가지 팁으로 배우는 개발자 말하기와 글쓰기 좋은 개발팀은 어떻게 리뷰하고 소통하는가?

코드 리뷰는 단순히 버그를 찾거나 잘못된 코드를 지적하는 과정이 아닙니다.

좋은 코드 리뷰는, 코드의 품질을 높이는 동시에 지식을 공유하고 개발자와 팀을 함께 성장시키는 중요한 협업 과정입니다.

 

이 책은 오랫동안 코드 리뷰를 개발 문화와 팀 육성의 핵심으로 실천해 온 일본의 개발회사 만요(万葉)의 실무자들이 모여 만든 책입니다. 만요는 코드 리뷰를 개발 프로세스와 사내 교육에 적극적으로 활용해왔습니다. 그 목적 또한 단순한 버그 발견에 두지 않고 코드 품질 향상과 지식 공유, 다양한 선택지에 대한 논의와 합의, 개발자의 기술력 향상과 팀의 성장을 위한 중요한 과정으로 코드 리뷰를 바라봅니다. 이러한 철학을 바탕으로 15년 이상 코드 리뷰를 실천하며 경험과 노하우를 축적해 왔습니다.

이 책 또한 이상적인 원칙이나 이론이 아닌, 실제 개발 현장에서 수많은 코드 리뷰를 주고받으며 쌓은 시행착오와 팀 운영 경험을 바탕으로, 현장에서 바로 적용할 수 있는 코드 리뷰 방법을 구체적인 사례와 함께 설명합니다. 특히 리뷰 과정에서 발생하는 오해와 갈등, 질문과 설명, 피드백과 논의 등 사람과 협업에 초점을 맞춘 리뷰 기술을 다룹니다. 코드 리뷰가 부담스러운 주니어부터 리뷰의 품질을 높이고 싶은 시니어, 더 나은 개발 문화를 만들고 싶은 팀 리더까지, 좋은 코드와 좋은 개발팀을 함께 만들어 가고 싶은 모든 개발자를 위한 실전 코드 리뷰 가이드입니다.

[목 차]

PART 1 마음가짐

전달력 있는 코드 리뷰란?

전달력 있는 코드 리뷰의 5대 원칙

 

PART 2 실전

Case 1 긴장감 넘치는 리뷰 코멘트

Case 2 설명이 부족한 PR

Case 3 진행이 더딘 PR

Case 4 사고방식이나 가치관의 차이

Case 5 지나치게 자세한 리뷰 코멘트

Case 6 Linter에 의존한 수정

Case 7 ‘그 사람이 말했으니 괜찮지’라는 사고 금지

Case 8 질문 코멘트에 답하지 않은 수정 PR

Case 9 리뷰 포인트를 이해하기 어려운 PR

Case 10 지나치게 눈치를 보는 리뷰 코멘트

Case 11 리뷰되지 않은 PR

Case 12 사전 조건이 명확하지 않은 PR

Case 13 코멘트에 대한 정정 정보 부족

Case 14 방치된 논의

Case 15 놓친 질문 코멘트

Case 16 상상에 기반한 수정

Case 17 찾아보지도 않고 하는 질문

Case 18 관계자에게 확인하지 않은 PR

Case 19 감정적인 코멘트

 

PART 3 TIPS

TIP 01 퀴즈를 내지 않는다

TIP 02 명령하지 않는다

TIP 03 성선설을 바탕으로 생각한다

TIP 04 상대방의 의도를 단정하지 않는다

TIP 05 우선은 공감을 표현한다

TIP 06 팀에서 공유할 태그를 만든다

TIP 07 Linter를 도입한다

TIP 08 작업 로그를 남기고 참조 위치를 링크한다

TIP 09 상담하는 시점을 정해 둔다

TIP 10 막힌 상황을 전달한다

TIP 11 이해 수준을 전달한다

TIP 12 돌려 말하지 않는다

TIP 13 자신의 생각과 의견을 덧붙인다

TIP 14 근거가 없다면 없다고 덧붙인다

TIP 15 상세 정보를 명시한다

TIP 16 무엇을 해 주길 원하는지 전달한다

TIP 17 만일을 위해 다시 한 번 확인한다

TIP 18 채팅에서 대화로 전환한다

TIP 19 질문 상대를 명시한다

TIP 20 효과적으로 재촉한다

TIP 21 기한을 명시한다

TIP 22 바로 답변할 수 없음을 전달한다

TIP 23 질문을 좁힌다

TIP 24 상대방의 지식 수준에 맞춘다

TIP 25 예/아니오로 답변받는다

TIP 26 목표는 이기는 게 아니라 납득시키는 것이다

TIP 27 Before/After 이미지를 이용한다

TIP 28 하지 않은 것을 기술한다

TIP 29 템플릿을 준비한다

TIP 30 레이블을 붙인다

TIP 31 목록 형식을 사용한다

TIP 32 리뷰어 지명 로직을 만든다

TIP 33 상대방의 이해 단계에 따라 진행한다

 

감수자 후기

TIPS 대응표

 

[본 문]

[지은이 서문]

이 책은 팀의 코드 리뷰 커뮤니케이션을 개선하고, 신뢰 관계를 바탕으로 솔직하고 효율적인 협업 문화를 만들어 그 안에서 개발하고자 하는 모든 개발자를 위한 책입니다.

저자 셋은 ‘주식회사 만요’라는 개발 회사와 각자 다른 방식으로 인연을 맺고 있습니다. 만요에서는 기술만큼이나 텍스트 커뮤니케이션의 품질을 중요하게 생각합니다. 메신저 운영, 이메일 문구, 문서 작성 방식, 코드 리뷰에 이르기까지 좋은 텍스트 커뮤니케이션은 개발 효율에 직접적으로 큰 영향을 미친다는 것을 알고 있기 때문입니다.

종종 다른 회사로부터 “만요의 풀 리퀘스트 방식을 본받고 싶다”라는 말을 듣곤 합니다. 이는 다양한 개발 현장에 투입되어 즉시 역할을 수행해야 하는 SES(System Engineering Service, 시스템 엔지니어링 서비스)라는 업무 형태 속에서 형성된, 만요만의 ‘기술’이라 할 수 있습니다.

코드 리뷰에서의 소통은 개발의 품질을 좌우하는 중요한 프로세스입니다. 커뮤니케이션이 원활하지 않으면 개발에 악영향을 미치지만, 이를 개선하면 개발 경험을 크게 향상시킬 수 있습니다.

 

[옮긴이 서문]

저자들은 특히 코드 리뷰 커뮤니케이션을 막연한 태도나 감각의 문제가 아니라 학습하고 훈련할 수 있는 기술의 영역으로 다룹니다. 제한된 텍스트만으로 어떻게 오해의 여지를 줄이고 의도를 정확히 전달할 수 있을지 오랫동안 고민해 온 흔적이 책 곳곳에 담겨 있습니다.

질문의 범위를 좁히는 법, 요구 사항을 명확히 하는 법, 상대방의 지식 수준에 맞춰 설명하는 법, 논의가 정체되었을 때 다시 원활하게 소통을 시작하는 법 등 개발 현장에서 흔히 마주칠 수 있는 상황들을 하나하나 짚어 줍니다.

텍스트 기반의 협업이 늘어난 지금, 이 책의 조언은 코드의 품질뿐만 아니라 개발 과정 전반에 좋은 영향을 미칠 것입니다. 좋은 커뮤니케이션이란 말을 부드럽게 하는 데서 끝나지 않습니다. 상대를 배려하면서도 필요한 내용을 분명히 전달하고, 서로 다른 전제를 맞추며, 중요한 부분을 함께 확인해 나가는 일입니다.