좋은 코드리뷰를 위해서

코드리뷰란?

소스 코드의 일부를 주로 보고 읽음으로써 한 명 또는 여러 명이 프로그램을 점검하는 소프트웨어 품질 보증 활동이다.

따라서 코드 작성자와 리뷰어가 존재한다.

 

좋은 코드리뷰 문화를 만들어가기 위해선?

 

Git Pull Request 를 통한 코드리뷰 기준으로...

 

Assignee

: 해당 작업의 담당자

-> 보통 자기 자신을 할당한다.

 

Reviewer

프로젝트당 리뷰어 지정이 필수적이며, 관련 프로젝트가 아니여도 리뷰가 가능하다.

 

Label

: 해당 작업의 설명

PR의 상태를 한눈에 알아볼 수 있다.

규칙은 정해진 것은 없어서 회사마다 분류가 다 다른 것 같다.

 

ex 1) 보류, 병합대기, 리뷰중, 긴급

ex 2) bug, document, performance, refactoring

 

프로젝트에 대한 설명

해당 작업이 어떤 작업인지 알고 코드 리뷰를 하게되면 더 보는 사람 입장에서 쉽다.

PR 작성 시 어떤 작업을 했는지 간단 명료하게 적어야할 필요가 있다.

 

간단한 예제 코드

리뷰 시 단순히 말로 수정을 요청하는 것 보다는

가능한선에서 적절한 예제코드와 함께 리뷰를 하면 작성자 입장에서 수정 방향을 이해하기 쉬울 것 이다. 

단, 무시하는 느낌이 들지 않도록 중요한 부분만 예제코드로 작성함으로써 디테일한 부분은 작업자가 할 수 있도록 하면 좋을 것 이다.

 

서로간의 배려

마지막으로, 서로간의 배려가 필요하다.

사람과 사람간의 소통이 글로 이루어짐에 따라 더더욱 부드러운 말로,

같이 성장할 수 있도록 적극적으로 서로간에 리뷰를 주고 받으면 좋을 것 같다.

 

 

---

바쁠때는 다른 사람의 코드리뷰를 봐주기 힘들거나 어느날은 눈에 들어오지 않을 때 가 있지만,

코드리뷰는 장점이 더 많은 것 같다.

 

생각치 못했던 우려되는 부분을 알려주거나, 오타 발견 등 코드의 품질이나, 개발자의 실력 향상에 도움이 되는 것 같다.

 

---

 

코드리뷰 관련 좋은 글

 

PR / 코드 리뷰는 어떻게 하는게 좋을까?

 

좋은 코드리뷰에 대한 고찰

 

 

크몽 FE 팀 코드리뷰문화 개선기(1+1=3)