Pull Request

참고

1. https://git-scm.com/book/en/v2

Pull Request (PR)

내가 원본 repository를 fork하고

내가 변경한 repository에 push 하여 remote repository에 올리고 난 후, 변경 사항을 제안하고 다른 개발자와 협업하는 방법

내가 원본 repository를 fork하고 내 repository를

일반적으로 코드 변경을 제안하고, 검토하며 저장소의 브랜치를 병합할 때 사용

PR 만들기 예시

1. 새로운 branch 만들기

2. 코드 수정

3. 원격 저장소에 해당 branch push

PR 리뷰

함께 작업하는 작업자가 해당 PR을 리뷰

문제가 될만한 부분이 있는지 확인

PR Merge

branch 새로 만드는 것은 새로운 분기가 생기는 것이니 PR merge를 통해 다시 병합

병합 후 더이상 필요없는 브랜치 삭제 가능

PR Close

문제가 있거나, 중복이 된 경우, 더 이상 필요없느 pr 닫을 수 있음

PR을 열어둔 상태에서 기존 branch에 commit하면 pr에도 모두 반영

예시

1. 새로운 branch를 만듦

   git checkout -b abc
   

   • abc 생성

2. 작업을 진행하고 변경 내용을 commit

   git commit -a -m "main func arg name change"
   

3. commit한 내용을 remote repository에 push

   git push -u origin abc
   

4. push한 remote repository에서 pull request 하고 merge

   

   • compare & pull request 버튼 클릭

   
   

   

   • compare는 내가 작업한 branch이고 base의 master는 내가 병합을 하려고 하는 branch
   • compare, branch를 선택한 후 Create pull request 버튼 클릭

   
   

   

   • PR open

   
   

   

   • PR이 Open 된 상태로 작업을 수행하고 commit, push를 하면 PR에 반영
   • 이상이 없다면 Merge pull request 버튼 클릭

   
   

   

   • Confirm merge

   
   

   

   • 기존 remote repository의 branch가 필요 없다면 삭제 가능
   • abc branch 삭제

   
   

   

   • 삭제한 branch 복구 가능

Draft PR

Git의 built-in 기능은 아니지만 Github에서는 지원

Draft PR에 올려져 있으면 변경점을 지속적으로 볼 수 있지만 아직 리뷰를 받을 상태는 아니라는 것을 알림

작업한 내용을 braodcasting 하여 내 작업이 어디까지 진행이 되었으며 얼마나 남았는지 공동으로 작업하는 사람들에게 알려 줄수 있음

규모가 큰 작업인 경우 많이 사용

예시

1. Local에서 작업을 진행하고 add, commit, push 진행하여 remote repository에 올림

2. push한 remote repository에서 Draft PR

   

   • compare & pull request 버튼 클릭

   
   

   

   • base와 compare 에 알맞은 branch 설정
   • Create draft pull request 선택

   
   

   

   • Draft pull request 선택

   
   

   

   • Draft PR을 진행하여도 commit 한 내용 확인 가능
   • Merge는 할 수 없지만 코드 리뷰는 가능
   • Close pull request 를 통해 close