Github에서 Pull Request 하는 방법

1. Pull Request 순서

  1. Fork
  2. clone, remote설정
  3. branch 생성
  4. 수정 작업 후 add, commit, push
  5. Pull Request 생성
  6. 코드리뷰, Merge Pull Reqest
  7. Merge 이후 branch 삭제 및 동기화


2. Fork

  • 타겟 프로젝트의 저장소를 자신의 저장소로 Fork 한다.
missing
Fork Button 위치


  • Fork가 완료되면 자신의 계정에 새로운 저장소가 생긴다.
missing
Fork 확인


3. clone, remote 설정

  • fork로 생성한 본인 계정의 저장소에서 clone or download 버튼을 누르고 표시되는 url을 복사한다.
missing
Fork된 저장소의 주소 확인


  • 자신의 컴퓨터에서 작업을 하기 위해서 Fork한 저장소를 로컬에 clone 한다.
      git clone https://github.com/ok97465/spyder.git
    


  • 로컬 저장소에 원격 저장소를 추가한다. 위 작업과 동일하게 github 저장소에서 clone or download 메뉴를 통해서 확인한 url을 사용한다.
     # 원본 프로젝트 저장소를 원격 저장소로 추가
     git remote add upstream(별명) https://github.com/spyder-ide/spyder.git
    
     # 원격 저장소 설정 현황 확인방법
     git remote -v
    
    • 원본 프로젝트 저장소 (직접 추가 필요)
    • fork한 로컬 프로젝트 (origin이라는 별명으로 기본으로 추가되어 있다. 따로 추가할 필요 없음)


4. branch 생성

개발을 하다 보면 코드를 여러 개로 복사해야 하는 일이 자주 생긴다. 코드를 통째로 복사하고 나서 원래 코드와는 상관없이 독립적으로 개발을 진행할 수 있는데, 이렇게 독립적으로 개발하는 것이 브랜치다. - pro git book

  • 자신의 로컬 컴퓨터에서 코드를 추가하는 작업은 branch를 만들어서 진행한다.
      # develop 이라는 이름의 branch를 생성한다.
      git checkout -b develop
      Switched to a new branch 'develop'
    
      # 이제 2개의 브랜치가 존재한다.
      git branch
      * develop
        master
    
  • upstream master가 아닌 다른 branch에서 작업하고 싶다면
      # upstream brach를 갱신한다.
      git remote update
        
      # upstream의 다른 branch를 확인한다.
      git branch -r
        origin/HEAD -> origin/master
        upstream/4.x
          
      # branch를 다운 받는다.
      git checkout -t upstream/4.x
        
      # develop 이라는 이름의 branch를 생성한다.
      git checkout -b develop
      Switched to a new branch 'develop'
    


5. 수정 작업 후 add, commit, push

  • 자신이 사용하는 코드 편집 툴을 활용하여 수정 작업을 진행한다.
  • 작업이 완료되면, add, commit, push를 통해서 자신의 github repository (origin)에 수정사항을 반영한다.
  • 주의사항 push 진행시에 branch 이름을 명시해주어야 한다.
      git push origin develop
    


6. Pull Request 생성

  • push 완료 후 본인 계정의 github 저장소에 들어오면 Compare & pull reqeust 버튼이 활성화 되어 있다.
  • 해당 버튼을 선택하여 메시지를 작성하고 PR을 생성한다.
missing


missing


7. 코드리뷰, Merge Pull Reqest

  • PR을 받은 원본 저장소 관리자는 코드 변경내역을 확인하고 Merge 여부를 결정한다.
  • 수정사항이 생겼을 경우 변경 후 origin에 push 한다.
      git add path
        
      git commit -m "수정내용"
        
      git push origin develop
    
  • Rebase 요청이 왔을 경우 아래와 같이 rebase를 수행한다.
      git checkout master
        
      git fetch upstream master
        
      git merge upstream/master
        
      git checkout develop
        
      git rebase master
        
      git push origin develop --force
    
  • 내 코드와 관계 없이 Test에 실패하여 Test를 다시 수행해 보고 싶은 경우 마지막 commit의 주석만 고친다.
    git commit --amend -m "이전 내용에서 약간 수정한 내용"
    git push origin develop --force
    


8. Merge 이후 동기화 및 branch 삭제

  • 원본 저장소에 Merge가 완료되면 로컬 코드와 원본 저장소의 코드를 동기화 한다.
  • 작업하던 로컬의 branch를 삭제한다.
      # 코드 동기화
      git pull upstream
        
      # 브랜치 삭제
      git branch -d develop
    
  • 나중에 추가로 작업할 일이 있으면 git pull upstream 명령을 통해 원본 저장소와 동기화를 진행하고 (branch 삭제~Merge)를 반복한다.


9. 참고자료

[1] https://wayhome25.github.io/git/2017/07/08/git-first-pull-request-story/