[코드리뷰] 코드리뷰 by 드림앨리

코드리뷰를 어떻게 잘할 수 있는지 조사해보았다.

작성자를 위한 팁

1. 코드는 내가 아니다 (감정적으로 받아들이지 않기)

→ 리뷰어의 좋은 의도, 불치하문

2. PR 사이즈를 최대한 작게 (코드 변경을 작게) → 400줄 이하로

- 버그 하나당 하나의 PR

- 버전 업데이트 및 리팩토링은 별도의 PR

- 규모가 큰 변경 사항은 의미 있는 작은 단위로!

3. 맥락(Context)를 이해할 수 있도록 정보 제공 Why > What

4. 빠른 시일 내에 리뷰를 받도록 최선을 다하기

-까지 리뷰 가능

5. 코멘트에 대해 명확하게 피드백을 하기

ack 네, 반영했습니다.

리뷰어를 위한 팁

1. 컨벤션에 관한 리뷰는 자동화한다.

테스트 커버리지, esLint, Formatter, Team’s convention 누락된 기능(케이스) 조기 발견 버그 및 실수 조기 발견 테스트 코드의 작성 여부 코드 컨벤션이 잘 지켜졌는가 가독성과 확장성, 유지보수 편의성 팀원들의 이해도 향상 코드 퀄리티 향상

2. 좋은 의도를 전제로, 친절하게!

Craft : 호기심을 가지고 작성자의 의도를 파악

3. 명확하고 구체적인 피드백을 주기

1) 친절하게! 이유와 함께

2) 이유를 다른 대안/추천하는 방식과 함께

3) 중요성에 따라 명확한 행동을 촉구

 - 질문(QQ)

 - 마이너(NIT)

 - 변경(RC)

4. 리뷰 완료를 명확하게 알려라

1) 승인

2) 전체 방향성 OK (but, 작은 변경 요청)

  - 이름 변경

  - 순서 변경

3) 변경 요청

4) 이대로 배포 불가

  - 코드 수정 필요

5) 질문

  - 코드 의도 파악

  - 큰 그림의 질문

  - 설계적인 질문

 

 

---

 

참고)

https://www.youtube.com/watch?v=JTEXwh4kq0k