코드 리뷰의 중요성과 잘하는 법

• 코드 리뷰의 이점

코드 품질 개선, 버그를 미리 예방

팀 지식 공유를 통한 성장

팀 개발 표준을 통한 확장성

 

• 코드 리뷰를 힘들게 하는 것들

무응답

느린 속도

공격적인 커뮤니케이션

 

코드 리뷰는 지적하는 것이 아니라 의견을 나누고 질문을 하는 것 (커뮤니케이션)

코드 리뷰하느라 작업이 느려진다? → 코드 리뷰를 안해서 다시 고치거나 버그에 대응하는 것이 더 오래 걸린다!

 

‘너’ 보다는 ‘우리’ 라는 말 쓰기!

→ 코드를 리뷰하는게 아니라 상대를 리뷰하는 듯한 느낌을 줄 수 있다.

형용사/부사 사용하지 않기

→ 엄청 큰 실수를 한 것 같은 느낌을 줄 수 있다.

 

코드 ≠ 나

나에 대한 평가가 아니라 그저 코드에 대한 리뷰이다.

 

리뷰는 당연한 것이 아니다. 리뷰어에게 감사하는 마음을 갖자.

 

• 어떻게 하면 코드 리뷰를 잘할 수 있을까?

빠르게 리뷰하기

nit (사소한 실수) 줄이기, 자동화 도입 (AI 사용)

변경 사이즈 줄이기

 

코드 리뷰는 방치 될수록 가치가 떨어진다.

코드 리뷰를 하고 있다고 빠르게 리액션이라도 하기.

반드시 반영되어야 하는 중대한 코드 수정 의견 같이 우선순위가 높은 의견이 아니라 다음에 반영해도 되거나 사소한 의견이면 코드를 먼저 배포해도 된다고 말하기.

우선순위가 높은 의견 → 버그 가능성이 있거나 잘못된 구현인 경우, 잠재적인 이슈나 확장성을 고려해야 하는 경우

모두 다 반영하려고 하면 지친다.

중요한 것은 지속 가능한 코드 리뷰 문화이다.

 

nit ⇒ 사소하고 작은 문제로 주로 스타일 가이드 준수, 가독성 개선 등을 의미한다. 전체적으로는 중요하지 않지만 품질 향상에 도움이 될 수 있는 부분에서 사용한다.

간단한건 무미건조하게! 자동화 시스템으로 고치거나 짧게 말하고 넘어가기.

 

코드 변경 사이즈가 커지면 자연스럽게 코드 리뷰가 오래 걸리게 된다.

리뷰할 내용이 커지면 리뷰하기가 부담되고 다른 작업과 충돌할 가능성도 높아지고 코드 롤백 시, 모든 작업이 다 롤백될 수도 있다.

 

따라서 작업의 명확성을 올려서 코드 변경 크기를 줄여야 리뷰 속도를 올릴 수 있다.

 

The single responsibility principle (SRP)

하나의 Pull Request에는 하나의 관심사만!

ex) 댓글 기능 추가 X / comment API 생성, comment 서버 로직 생성, comment component 생성 O

 

잊지 말아야 할 것!

⇒ 코드 리뷰는 혼자 하는게 아니라 커뮤니케이션이다! 따라서 공감과 신뢰가 가장 중요하다.

 

코드 리뷰 자동화 방법 검색하면 좋은거 많이 나온다.

GitHub Copilot

코드 리뷰 AI 프롬프트 예시

등등

 

Copilot 가 github 에서 사람들이 많이 작성한 요약, branch 등을 이미 다 학습하고 있어서 좋은 조언을 많이 해줌.