좋은 코드 리뷰 나쁜 코드 리뷰
책 소개
리뷰 코멘트 하나가 팀의 생산성을 바꾸고,
좋은 리뷰 한 줄이 팀의 문화를 바꾼다!
코드 리뷰가 길어지고, 같은 내용을 반복해서 설명하고, 사소한 오해가 불필요한 논쟁으로 이어진다면 문제는 코드가 아닐지도 모릅니다. 코드 리뷰는 버그를 찾는 과정이 아니라 서로의 의도를 이해하고 더 나은 결과를 함께 만들어 가는 협업의 과정입니다.
이 책은 수많은 코드 리뷰 경험을 바탕으로 신뢰를 쌓는 소통 방법, 오해를 줄이는 질문과 설명 방법, 리뷰를 효율적으로 이끄는 피드백 기술을 실제 사례와 함께 소개합니다. 질문하는 법, 의견을 전달하는 법, 리뷰를 받는 법, 논의를 마무리하는 법까지 개발 현장에서 바로 적용할 수 있는 실천적인 노하우를 담았습니다.
좋은 코드 리뷰는 더 좋은 코드를 만드는 데서 끝나는 것이 아니라 팀의 협업 문화를 바꾸고, 개발 경험을 향상시키고, 함께 성장하는 조직을 만드는 출발점이 됩니다. 이 책은 코드 리뷰가 어렵게 느껴지는 주니어부터 팀의 협업 문화를 고민하는 시니어와 리더까지, 모든 개발자를 위한 코드 리뷰 가이드입니다.
작가 소개
토리이 유키
프로그래머, NPO 법인 Waffle 커리큘럼 매니저, 만요 펠로우. 저서로는 『유우와 마법 프로그래밍 노트』(오라일리 재팬)가 있으며, 번역서로는 『루비의 모험』(쇼에이사), 『프로그래밍 Elixir』(옴사, 사사다 코이치 공역) 등이 있다. 2023년도 도쿄서적 국어 교과서에 프로그래밍 관련 글이 실렸다. Rails Girls Tokyo 및 NPO 법인 Waffle 등에서 여성과 초보자를 위한 활동 경험 다수. 2024년 포브스 재팬 'Women In Tech 30: 테크놀로지 분야에서 미래를 창조하는 30인의 여성'에 선정되었다.
목 차
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 대응표
역자 소개
- 단순 변심인 경우 : 상품 수령 후 7일 이내 신청
- 상품 불량/오배송인 경우 : 상품 수령 후 3개월 이내, 혹은 그 사실을 알게 된 이후 30일 이내 반품 신청 가능
| 반품사유 | 반품 배송비 부담자 |
|---|---|
| 단순변심 | 고객 부담이며, 최초 배송비를 포함해 왕복 배송비가 발생합니다. 또한, 도서/산간지역이거나 설치 상품을 반품하는 경우에는 배송비가 추가될 수 있습니다. |
| 고객 부담이 아닙니다. |
| 진행 상태 | 결제완료 | 상품준비중 | 배송지시/배송중/배송완료 |
|---|---|---|---|
| 어떤 상태 | 주문 내역 확인 전 | 상품 발송 준비 중 | 상품이 택배사로 이미 발송 됨 |
| 환불 | 즉시환불 | 구매취소 의사전달 → 발송중지 → 환불 | 반품회수 → 반품상품 확인 → 환불 |
- 결제완료 또는 배송상품은 1:1 문의에 취소신청해 주셔야 합니다.
- 특정 상품의 경우 취소 수수료가 부과될 수 있습니다.
| 결제수단 | 환불시점 | 환불방법 |
|---|---|---|
| 신용카드 | 취소완료 후, 3~5일 내 카드사 승인취소(영업일 기준) | 신용카드 승인취소 |
| 계좌이체 |
실시간 계좌이체 또는 무통장입금 취소완료 후, 입력하신 환불계좌로 1~2일 내 환불금액 입금(영업일 기준) |
계좌입금 |
| 휴대폰 결제 |
당일 구매내역 취소시 취소 완료 후, 6시간 이내 승인취소 전월 구매내역 취소시 취소 완료 후, 1~2일 내 환불계좌로 입금(영업일 기준) |
당일취소 : 휴대폰 결제 승인취소 익월취소 : 계좌입금 |
| 포인트 | 취소 완료 후, 당일 포인트 적립 | 환불 포인트 적립 |
- 단순변심으로 인한 반품 시, 배송 완료 후 7일이 지나면 취소/반품 신청이 접수되지 않습니다.
- 주문/제작 상품의 경우, 상품의 제작이 이미 진행된 경우에는 취소가 불가합니다.
- 구성품을 분실하였거나 취급 부주의로 인한 파손/고장/오염된 경우에는 취소/반품이 제한됩니다.
- 제조사의 사정 (신모델 출시 등) 및 부품 가격변동 등에 의해 가격이 변동될 수 있으며, 이로 인한 반품 및 가격보상은 불가합니다.
- 뷰티 상품 이용 시 트러블(알러지, 붉은 반점, 가려움, 따가움)이 발생하는 경우 진료 확인서 및 소견서 등을 증빙하면 환불이 가능하지만 이 경우, 제반 비용은 고객님께서 부담하셔야 합니다.
- 각 상품별로 아래와 같은 사유로 취소/반품이 제한 될 수 있습니다.
| 상품군 | 취소/반품 불가사유 |
|---|---|
| 의류/잡화/수입명품 | 상품의 택(TAG) 제거/라벨 및 상품 훼손으로 상품의 가치가 현저히 감소된 경우 |
| 계절상품/식품/화장품 | 고객님의 사용, 시간경과, 일부 소비에 의하여 상품의 가치가 현저히 감소한 경우 |
| 가전/설치상품 | 전자제품 특성 상, 정품 스티커가 제거되었거나 설치 또는 사용 이후에 단순변심인 경우, 액정화면이 부착된 상품의 전원을 켠 경우 (상품불량으로 인한 교환/반품은 AS센터의 불량 판정을 받아야 합니다.) |
| 자동차용품 | 상품을 개봉하여 장착한 이후 단순변심의 경우 |
| CD/DVD/GAME/BOOK등 | 복제가 가능한 상품의 포장 등을 훼손한 경우 |
| 상품의 시리얼 넘버 유출로 내장된 소프트웨어의 가치가 감소한 경우 | |
| 노트북, 테스크탑 PC 등 | 홀로그램 등을 분리, 분실, 훼손하여 상품의 가치가 현저히 감소하여 재판매가 불가할 경우 |