[Github] Pull Request를 통해 코드리뷰 하는 방법

정재현·2024년 2월 14일

Git & Github

목록 보기
13/16
post-thumbnail

코드리뷰가 중요한 이유

  • Merge를 할지 말지가 결정하는 확인절차 중 하나이기 때문

Pull Request

협업을 하다가 브랜치 작업을 마치고 develop 또는 master 브랜치에 병합(merge)를 하기 전 해야하는 작업이 Pull Request(PR)이다.

  • 즉, 병합(merge)를 하기 전 확인을 받는 절차

코드리뷰(PR review) 과정

  1. 브랜치에서 작업을 수행하고 Push 한 경우 PR을 보낼 수 있는 화면이 뜬다
    → Compare & request 버튼을 눌러서 다음으로 넘어가기

// 자동 merge가 되지 않는 다면 충돌이 발생했을 상황 : Conflic resolve 버튼으로 충돌 해결

  1. Create Pull Request 버튼을 눌러서 PR 생성

    Reviewers : 현재 Pull Request(PR)을 리뷰를 해 줄 팀원 지정
    Assignees : 현재 Pull Request(PR) 작업의 담당자 지정

  2. Reviewer 지정
    → Reviewr를 지정해주면 해당 사람에게 메일로 알림이 간다.

    Reviewers : PR review할 팀원(코드리뷰 하는 사람)

  3. 리뷰가 필요하거나, 궁금한 코드가 있는 줄에 마우스를 가져가보면 + 버튼을 볼 수 있고, 그것을 클릭하면 다음과 같이 리뷰를 작성할 공간이 생긴다.
    → 코드리뷰가 마무리 되었다면 오른쪽 위에 Review change를 눌러 넘기기

  4. 리뷰 총평 커멘트를 달고 3가지 버튼 중 하나를 선택해 Submit review를 누르면 리뷰가 마무리 된다.

    Comment : 승인과 무관하게 일반적인 커멘트를 할 때 선택
    Approve : Comment와 다르게 Reviewer가 승인을 하는 것으로, Merge해도 괜찮다는 의견을 보내는 것
    Request changes : 변경을 요청하는것. 즉, 승인을 거부하는 것.


PR의 Approve 개수 설정 방법

  • 프로젝트 - Settings - Branchs - Protect matching branches
  • Requre Pull Request reviews before merging : Approve를 받아야 Merge를 할 수 있도록 설정 가능
  • 지금은 1명의 Approve를 받으면 Merge가 가능하게 되어있지만, 여러 명을 설정해 일정 개수 이상의 Approve를 받아야 Merge할 수 있게 설정할 수 있다.

profile
공부 기록 보관소

0개의 댓글