[Git] Code Review 코드리뷰 기능 사용하기

코드리뷰란?

코드 병합 전, 일차적인 리뷰를 통해 오류를 확인할 수 있다. 

개인적으로 느낀 사이드 프로젝트에서의 코드 리뷰의 장점은 아래와 같다.

1. 지식 공유 : 다른 팀원의 코드를 상세하게 읽어볼 수 있어 어떤 방식을 사용했나 확인 가능
2. 코드 일관성 유지 : 코드 스타일을 확인하고 잘못된 경우, 코딩 규칙을 준수하도록 유도할 수 있다.
3. 문서화 : 코드 리뷰 과정에서 코드의 의도와 동작을 설명하여 문서화 가능 -> 나중에 확인할 일이 있을 때 도움이 된다.

 

 

 

코드 리뷰 전단계 : Pull Request 생성

코드 리뷰를 위한 전 단계 Pull Request(PR) 생성은 아래 게시글 참고해주세요.

https://skylarcoding.tistory.com/225

[Git] Git 의 Issue 와 Pull Request, Review 기능 사용하기 (merger금지, 커밋과 이슈연결 등)

 

 

 

코드 리뷰

 

 

리뷰어 (Reviewers) 등록방법

위 사진 오른쪽 하단의 Reviewers 가 있다. 톱니바퀴를 눌러 리뷰 요청을 하면 된다. 

사람 이름 왼쪽에 체크 표시가 되어있으면 리뷰어 등록이 된 것이다.

 

 

리뷰하는 방법

Pull Request(PR) 에 내가 리뷰어로 등록되어 있으면 PR 상세 페이지에 아래와 같이 나타난다.

리뷰어로 등록되어 있지 않아도 Files changed 를 클릭하면 리뷰를 작성할 수 있다. 

 

리뷰 작성하기

코멘트 달기

코드 각각에 코멘트를 작성할 수 있다.

빨간색은 삭제된 부분, 초록색이 추가된 부분이다.

파란색의 진한 부분을 누르면 "Expand All" 이라는 메세지와 함께, 숨겨진 부분도 확인할 수 있다. Changes 에서는 변경된 부분만 보여주기 때문에 코드 전체를 확인해야 하면 Expand All 로 코드 전체 흐름을 확인할 수 있다.

 

 

코드를 여러 줄 선택해야 할 경우 + 버튼을 누른 상태로 드래그 하면 된다.

선택된 부분은 노란색으로 나타나며, 코멘트를 작성할 수 있는 댓글란이 생성된다. 

해당 코드에 대한 코멘트를 작성하려면 내용 입력 후, "Strat a Review" 를 선택하면 된다. 그러면 여러 개의 코멘트를 작성할 수 있다.

하나의 코멘트만 작성해야 할 경우, Add Single Comment 를 선택하면 된다.

 

 

 

코멘트 작성 완료하기

원하는만큼 코멘트를 달았으면, 상단 오른쪽 Review changes를 선택한다. 

전체적인 코멘트를 작성하는 것은 선택사항이다.

승인을 원할 경우 Approve, 그저 댓글이면 Comment, 코드에 변화를 원하면 Request changes 를 선택하면 된다.

 

코드 리뷰 승인이 있어야 하는 프로젝트에서는 Approve 를 해주지 않으면 Merge 가 불가능하다.

 

 

 

 

보조기능

상단 PR 제목 아래의 Changes from all commits, File filter, Conversations 등 Review의 보조 기능이 존재한다.

 

Changes from all Commits

는 commit 별로 changes 를 확인할 수 있는 필터이다.

하나의 PR에 많은 기능이 추가된다면 commit을 쪼개 올리면 좋을 것 같다. 그러면 Review 를 더 쉽게 할 수 있을 것으로 기대된다.

 

 

File filter

은 말 그대로 파일별로 확인할 수 있다.

 

 

Conversation

는 해당 PR에 대해 나온 댓글들을 확인할 수 있다.

해당 코멘트가 해결되면 Resolve conversation 을 클릭하면 Unresolved 에서 Resolved로 변경된다.

 

 

 

위 기능들을 처음부터 100퍼센트 활용하기는 쉽지 않다.

하지만 익숙해질 때 엄청난 업무 효율을 보일 것이 분명하다고 느껴진다.

한번씩 사용해보는 것도 좋을 것 같다.

 

git 관련 설정 더 보러가기

'Coding/Git' 카테고리의 글 목록