코드를 Merge 하기 위해 팀원에게 리뷰를 받는 단계인 Pull Request에 대한 Template 생성과 코드 리뷰 실습을 진행합니다.

실습 준비

해당 실습 자료는 2. Github Issue 기반으로 개발하기에서 이어집니다.

1. Pull Request Template 생성하기

   • Pull Request Template은 .github/PULL_REQUEST_TEMPLATE.md 파일을 추가 해야합니다.

   • 이전 실습에서 넘어오신 분들은 feat-1/add-funcion 브랜치에서 main 브랜치로 이동해주세요.

     • git checkout main 명령어로 이동할 수 있습니다.

     

   • .github/PULL_REQUEST_TEMPLATE.md 경로에 파일을 생성하고 다음과 같이 입력합니다.

     • Overview - 작업에 대한 개요
     • Change Log - 작업에서 변경된 부분
     • To Reviewer - 리뷰어에게 전달할 내용
     • Issue Tags - 해당 PR과 관련있는 Issue의 Tag
       • Pull Request 본문에 Resolved, Closed, Fixed 같은 키워드와 함께 Issue Tag가 작성되어있고, Github Repository의 Default Branch에 Merge 되는 경우 PR Merge 와 함께 Issue를 닫을 수 있습니다.

     ## Overview
     -
     
     ## Change Log
     -
     
     ## To Reviewer
     -
     
     ## Issue Tags
     - Closed | Fixed: #
     - See also: #
     

     

   • Commit 을 남기고 Push 합니다.

     • Pull Request Template 추가 작업 역시 프로젝트 초기 생성 시 진행하므로 main 브랜치에 직접 Merge 합니다. 그렇지 않은 경우에는 상황에 따라 브랜치를 사용해 Merge 합니다.

     

   • .github 경로에서 Pull Request Template이 추가된 것을 확인할 수 있습니다.

     

2. Pull Request 생성하기

   • 이전 실습에서 Push 해둔 feat-1/add-function 작업에 대해 Pull Request를 생성합니다.

     

   • 다음과 같이 생성한 Pull Request Template의 내용대로 입력되어있는 것을 확인할 수 있습니다.

     

   • Pull Request의 내용을 입력한 뒤 생성합니다.

     • 본문을 규칙에 맞게 입력하고, 리뷰어 및 담당자를 지정합니다.

     

   • 다음과 같이 Pull Request가 생성됩니다.

     

   • 이 때 리뷰 요청을 받은 리뷰어는 메일 혹은 지정한 방식으로 알림을 받게 됩니다.

     • 또는 Pull Request를 만든 사람이 리뷰어에게 리뷰를 직접 요청합니다.

3. Pull Request에서 코드 리뷰 남기기

   • 이번에는 코드 리뷰를 요청 받은 리뷰어의 시점으로 진행합니다. 다음과 같이 이메일을 받고 리뷰를 시작한다고 가정하겠습니다.

     (실습을 진행하실 때는 자료의 예시처럼 2개의 계정을 왔다갔다 하실 필요는 없습니다.)

     

   • 리뷰어가 Pull Request에 들어오면 다음과 같은 화면에서 얻을 수 있는 정보를 얻습니다.

     • 물론 리뷰를 진행하기 이전에 이미 논의가 된 내용일테니 기본적인 맥락은 이해하고 있을겁니다.
     • Pull Request 문서에 적혀있는 내용을 확인하고, 필요하다면 Issue 링크로 이동하여 추가적인 정보를 얻습니다.

     

   • Files changed 탭으로 이동하여 코드 리뷰를 시작합니다.

     

   • 코드 리뷰는 코드 라인에 마우스를 올리면 + 버튼으로 시작할 수 있습니다.

     • 클릭하고 드래그를 하면 영역을 선택하는 것도 가능합니다.

   

   • 다음과 같이 메시지를 남길 수 있습니다.

   

   • Preview 오른쪽에 있는 +-가 포함된 문서 기호를 선택하면 코드 제안을 하는것도 가능합니다.

     • 코드 제안을 작성하고 Preview로 확인하면 다음과 같이 보여집니다.

     

   • 코멘트는 두 가지 방식으로 남길 수 있습니다.

     1. Add single comment - 남긴 코멘트를 바로 보여주는 방식
     2. Start a review - 여러 코멘트를 남기고 코멘트를 모아서 한번에 리뷰 메시지와 함께 보여주는 방식
     • 다음과 같이 Start a review를 선택하는 경우 리뷰가 Pending 되고, 오른쪽 상단에 Finish your review를 통해 리뷰를 남길 수 있습니다.

     

   • 리뷰는 세 가지 방식으로 남길 수 있습니다.

     1. Comment - 코멘트를 남기는 리뷰 입니다. 질문, 논의가 필요한 부분 등이 있을 때 사용합니다.
     2. Approve - Pull Request를 승인하는 리뷰 입니다.
     3. Request changes - 잘못 구현되었거나 버그 혹은 개선점이 명확히 보이는 경우 변경을 요청하는 리뷰입니다.
     • 리뷰를 남기면 다음과 같이 보여지게 됩니다.

     

4. Pull Request에서 코드 리뷰 반영하기

   • 작업 담당자의 시점으로 돌아와 팀원이 남겨준 코드 리뷰를 기반으로 수정해보겠습니다.

     

   • 에러가 발생했을 때 None을 반환하는 것 보다는 먼저 타입 에러를 그대로 반환하는 것으로 진행해보겠습니다.

   

   • 다음과 같이 코드를 수정하고 Commit & Push 합니다.
     • main 브랜치에서 feat-1/add-funcion 브랜치로 이동해주세요.
       • git checkout feat-1/add-funcion 명령어로 이동할 수 있습니다.

   

5. Pull Request 승인하기

   • 다시 리뷰어 화면으로 돌아가 변경된 코드를 승인해보겠습니다.

     • 코드가 업데이트되어 main.py 파일에 Outdated 표시가 생겼습니다.

     

   • Files changed 탭으로 이동하여 다음과 같이 메시지를 남기고 Pull Request를 승인합니다.

     

   1. Pull Request Merge 하기

      • 코드가 다음과 같이 승인 되었습니다.

        

      • 코드를 Merge 할 때 선택할 수 있는 방법은 세 가지가 있습니다.

        • Create a merge commit - Merge Commit을 남기고 코드를 Merge
          • 브랜치에서 발생한 Commit Log + Merge Commit
        • Squash and merge - 브랜치 내에 추가된 모든 Commit을 하나의 Commit으로 Squash 하고 코드를 Merge
        • Rebase and merge - 브랜치를 대상 브랜치와 Rebase 후 Merge

        

      • Create a merge commit으로 코드를 병합하겠습니다.

      • 다음과 같이 코드가 Merge 됩니다.

      • 1번 Issue 도 자동으로 닫힌 것을 확인할 수 있습니다.