Github PR 리뷰하기

PR 리뷰하기

팔만코딩경에 올렸던 게시글을 다시 정리하여 업로드한다

개요

풀 리퀘스트를 리뷰함으로써 머지 전 수정할 사항은 없는지 여러 사람이 함께 체크할 수 있다

소규모 프로젝트는 리뷰할 사항이 그렇게 많은 편이 아니지만, 프로젝트가 커질 수록 PR이 머지되는 속도가 점점 느려지고 리뷰로만 몇날 며칠을 꼴깍 새운다고 한다 (😱)

아무튼 간단하게나마 깃허브 리뷰방법을 적어본다

1. 리뷰할 풀리퀘스트 고르기

리뷰하고자 하는 풀리퀘스트를 고르자

예시로 일단 내가 올린 풀리퀘스트를 선택하도록하겠다

2. Files Changed 클릭

Files Changed를 통해 이 풀 리퀘스트에서 변경된 모든 파일과 수정점을 볼 수 있다

3. 리뷰 시작 (리뷰 코멘트 작성)

Files Changed에 들어가면 파일의 변경된 내용들이 이렇게 표시된다

(초록색 배경이 이번에 추가되거나 변경된 내용, 빨간색 배경이 이번에 삭제된 변경 이전의 내용)

 

숫자와 해당 라인 사이에 마우스를 올리면 파란색 + 버튼이 표시된다

+ 버튼을 클릭하면 무언가 코멘트를 달 수 있는 공간이 나온다

 

코멘트는 마크다운 문법을 그대로 적용할 수 있어 편리하다 (헤더, 백틱 코드블록, 리스트, 볼드나 이탤릭 등)

 

특별히 이 줄은 이렇게 바꾸었으면 좋겠다! 하는 게 있다면 Insert a suggestion 버튼을 누른다

(또는 백틱 3개 + suggestion 입력)

 

이 기능의 대박 장점은 이렇게 어느 부분을 어떻게 수정 건의했는지 예쁘게 보여주기 때문에, 수정하길 원하는 부분을 콕 찝어 알려주기 굉장히 편리하다!!

 

#을 이용해서 특정한 이슈 또는 풀리퀘스트 번호를 멘션할 수도 있다

자동으로 링크가 걸리기 때문에, 어떤 이슈 / 풀리퀘스트를 멘션한 건지 바로 확인이 가능하다

 

특정 유저를 멘션할 수도 있다 (예시는 저 입니다...)

 

마크다운 문법이 익숙치 않다면 메뉴바에 온갖 작성 형식들이 들어있기 때문에 적용하고 싶은 문자열을 드래그 + 원하는 버튼 클릭 으로 쉽게 적용할 수 있다

4. 리뷰 코멘트 추가

아 이정도면 만족한다 싶을 때 아래의 초록색 버튼을 누른다

리뷰를 처음 시작했을 때 (리뷰의 첫 번째 코멘트일 때) 는 Start a review 라는 문자열이 표시되고,

리뷰 중일 때 (리뷰의 첫 번째 코멘트가 아니고, 그 이후의 코멘트일 때) 는 Add review comment 라는 문자열이 표시된다

 

추가한 리뷰에 무언가 덧붙이고 싶으면 reply 기능을 사용할 수도 있다

Pending은 적용을 기다리는 리뷰라는 뜻

코멘트 작성을 잘못했을 때

오른쪽 위의 ... 버튼을 눌러 코멘트를 수정하거나 삭제할 수 있다

5. 리뷰 끝! 코멘트 제출!

우상단의 Finish your review 버튼을 누르자 (옆의 숫자 2는 지금까지 적은 리뷰 코멘트의 개수이다

마지막으로 할 말을 적을 수 있는 코멘트 칸이 나온다

 

코멘트를 적었다면 Submit review를 누른다

위의 라디오 버튼 선택지는 각각

• Comment - 코멘트만 작성
• (이 풀리퀘스트를 머지하는 것은 아직 명시적으로 허용하지 않되, 전체적인 리뷰만 진행)
• Approve - 머지 허용
• (리뷰가 완료되었고, 이정도면 머지해도 되겠다 싶을 때 머지 승인용 리뷰)
• Request changes - 제발 이부분 수정해 주세요
• (머지하기 전에 이 부분은 반드시 수정되어야 한다고 판단될 때 체크)

더 이상 수정할 점이 없다 싶으면 Approve를 통해 레포 관리자에게 아 이 풀리퀘 머지해도 될것같아용~ 을 알려주도록 하자

리뷰가 완료되면...

리뷰가 끝나면 해당 PR에 대하여 리뷰를 완료한 유저 목록이 PR 우상단에 표시된다

 

1번 말풍선: Comment, 아직 머지 허용단계는 아니고 코멘트만 작성하였다

2번 체크: Approved, 두 명이 이 PR에 대해 머지를 허용했음을 뜻한다

3번 ± 기호: Request Changes, 이 PR에 특정 부분을 꼭 수정하길 요청하였다

이때 체크의 경우 레포지토리 관리자일 때 밝은 초록색, 일반 유저일 경우 회색으로 표시되는 듯하다

6. 리뷰로 소통하기

본인의 풀 리퀘스트에서 또는 다른 작성자의 PR 리뷰를 읽어보다가 특별히 코멘트를 달고 싶은 부분이 있다면 해당 리뷰 코멘트에 댓글을 달 수도 있다

 

간단한 반응 이모지도 달 수 있다

좋은 리뷰라면 따봉이나 하트를 날려주도록 하자 👍 간단하게 감사를 표하는 방법

엄청 큰 프로젝트에서는 좋지 않은 리뷰에 대해 역따봉이나 🙁가 종종 달리는 것도 볼 수 있다

번외: 해결된 리뷰 접어두기

Resolve conversation 버튼을 통해 이미 해결된 리뷰 코멘트를 접어둘 수 있다

리뷰 코멘트가 적으면 가독성에 지장이 없지만, 리뷰가 많으면 스크롤의 압박이...

물론 show resolved 버튼을 누르면 다시 펼쳐볼 수 있다

 

접어두기를 해제하려면 show resolved를 통해 리뷰 코멘트를 펼친 뒤, Unresolve conversation을 누르면 된다

 

모든 수정사항을 수정하고 풀리퀘스트에 커밋을 추가할 경우, 이전의 리뷰 사항은 Outdated가 된다

한번 더 리뷰해서 이번엔 머지할 수 있을지 살펴보면 된다