[Project] 첫 번째 코드 리뷰 (CodeReview)

프로젝트를 과정에서 현직 개발자 멘토분께 여러차례 코드 리뷰를 받는 좋은 경험을 했다.

주변에 개발자로 일하는 지인이 없었기 때문에, 코드 리뷰를 통해 실무에 대한 이야기를 조금이나마 접할 수 있었다.

또한 실제로 코드 리뷰를 진행하는 기업들이 많기 때문에 코드 리뷰를 미리 경험하고, 리뷰 방법을 익힐 수 있는 좋은 경험이었다.

코드 리뷰 (PR 리뷰)

PR 리뷰 방법은 간단한데, Pull Request 시 reviewers를 지정하면 해당 reveiwer에게 이메일로 리뷰 요청이 전달된다.

아래 사진은 PR 리뷰를 요청한 상태인데, Reviewers와 Assignees에 각각 코드 리뷰 담당자와 요청자가 명시되어 있다.

여기서, 코드 리뷰 담당자가 모든 파일의 내용들을 확인하는 것은 번거로운 일일 수 있다.

따라서 전체적인 리뷰를 원하는 것이 아닌, 특정 코드에 대한 리뷰를 원한다면 해당 부분에 comment를 달아놓는 것이 좋은 방법이다.

pr 요청 시 주의할 점

리뷰를 해주는 담당자마다 다를 수 있는 내용이지만, 대부분의 경우 적용되는 내용일 것이라고 생각된다.

1. 기능 단위로 Pull Request를 하고 코드 리뷰를 요청한다.

• 코드 리뷰를 위한 PR의 단위가 너무 짧거나 길면 안된다.
  
  

2. 코드 리뷰를 작성하고 reviewer를 할당했다면 사전 노티 없이 commit을 추가하거나 PR을 종료하면 안된다.

• reviewer 입장에서는 코드 리뷰 요청이 와서 리뷰를 하려고 했는데, PR이 close 되어있다면 부정적인 인상을 줄 수 있기 때문에, 협업에 안 좋은 영향을 끼칠 수 있다.
  
  

3. comment 작성 시 되도록이면 single comment가 아닌 thread 기능을 쓰는 것이 좋다.

• 단일 comment를 여러 개 작성해야할 경우, single comment로 작성하면 각 comment마다 reviewer에게 메일이 발송되기 때문이다.

후기

• 실무에서 진행되는 코드 리뷰 flow를 익힐 수 있었다.
• 특정 기술이 실무에서는 어떤 방식으로 사용되는지 알 수 있었다.
• 모호했던 개념, 구글링으로는 얻기 힘든 실무 경험자에게서 나오는 경험담 등 유익한 지식들을 많이 얻을 수 있었다.