코드 리뷰에 대한 글들을 읽었다.

리더 분께 코드 리뷰를 조금 더 적극적으로 참여하면 좋겠다는 이야기를 들었다.

오타 수정, 불필요한 코드 제거(console.log나 사용하지 않는 코드), 더 좋은(이해하기 쉬운) 이름 제안, 의도대로 동작하는지 확인... 정도는 하고 있다. 더 멋진 리뷰를 하고 싶은데 잘 모르겠다 ㅠㅠ 그리고 내가 담당하지 않는, 잘 모르는 레포지토리 코드도 리뷰하고 싶은데 어떻게 하면 잘할 수 있는지도 궁금했다.

그래서 관련된 글을 읽고, 나만의 체크 리스트를 만들어야 겠다는 생각이 들어서 글을 쓴다.

 

코드 리뷰의 목적

1. 개발 단계에서 버그 빨리 잡기

2. 지식 공유를 통해 코드, 기술 이해도 높이기 

3. 함께 더 나은 결과물 만들기

 

코드 리뷰 요청할 때  ✅

- 해결하려는 이슈, 요구 사항에 관한 링크 걸어두기

- PR 너무 길지 않게 올리기

- 스크린 샷 

 

코드 리뷰할 때 ✅

- 관련 문서 읽어서 어떤 일을 하려고 하는지 이해하기.

- 코드를 로컬에서 실행시켜보기.

- 그냥 좋지 않다고만 평가하지 말기. 만약 그렇게 평가할 것이라면, 근거나 대안을 제시하기. (개인적인 취향이나 선호가 아니라 공식 문서, 팀 내 가이드를 근거로)

- 다른 방식을 제안할 때 링크, 예제(직접 코드 제안 or 의사 코드 등) 제공하기.

- 친절한 말투 ! (이모지 활용)

- 궁금한 것 있으면 질문하기.

- 칭찬하기.

- 비즈니스 로직을 몰라도 코드 자체를 리뷰할 수 있다.

- 꼭 모든 코드를 리뷰하기.

- 코드 품질을 개선하는 방향으로 가기.

- 리뷰할 양이 너무 많다면 오프라인 혹은 전화 리뷰를 요청하기. 아니면 작게 쪼개 달라고 요청하기.

- 추후 반영해도 될 것 같으면, 그렇다고 댓글에 남기기.

---

체크 리스트 📝

- 중복된 코드가 있는지? -> 함수, 클래스 분리하기.

- 하드 코딩한 값이 있는지? -> 변수로 만들고 좋은 이름 붙이기.

- 이름이 이해하기 쉬운지? 

- 예외 처리를 했는지?

- 함수가 한 가지 일만 하는지?

- 의도대로 동작하는지? 

- 그 코드가 그 위치에 있는 게 맞는지?

- 간단하게 할 수 있는지?

- 필요한 주석만 있는지? (어떻게 X, 왜 O)

- 코드 수정에 맞게 문서도 업데이트 되었는지?

- console.log() 가 남아있지는 않은지?

 

참고 자료

https://tech.trenbe.com/2022/03/01/CodeReviewGuide.html

코드 리뷰 가이드 - 트렌비 기술블로그

https://tech.kakao.com/2022/03/17/2022-newkrew-onboarding-codereview/

효과적인 코드리뷰를 위한 리뷰어의 자세

https://soojin.ro/review/

Review · Soojin Ro

https://jbee.io/essay/how-to-code-review/

다른 사람의 코드를 리뷰하는 방법