GitHub에서 Fork 및 Pull Request (PR) 작성 방법을 알아보기 위해 저장소를 만들었습니다.
이 문서는 XpressEngine으로 Pull Request(PR) 작성 방법을 습득하기 위하여 작성되었습니다.
Linux에 Git이 설치되어 있으며 GitHub에 아이디가 생성되어 있어야 합니다.

주요 정보

• 저장소 : https://github.com/akasima/Pull-Request-Test
• 저장소 소유자 아이디 : akasima
• 일반 사용자 아이디 : akasima-pr-sender

akasima 아이디로 Pull-Request-test 저장소를 만들었습니다.
XpressEngine과 동일한 코드 수정 및 예시를 작성하기 위해 XpressEngine의 코드를 올려두었습니다.

이하 컨트리뷰터로 GitHub에 로그인했으며 Local 저장소 예시 또한 모두 컨트리뷰터의 저장소입니다.

Github에서 저장소 Fork 하기

akasima-pr-sender는 어떤 저장소도 갖고 있지 않습니다.

GitHub의 akasima Pull-Request-Test 저장소로 이동해서 fork합니다.

저장소를 fork 중입니다. 완료되면 아래 페이지로 이동됩니다.

fork가 완료되었습니다. fork 완료 후 컨트리뷰터의 저장소로 이동됩니다.

Fork 한 저장소를 컨트리뷰터의 local 저장소로 clone 하기

fork된 저장소를 컨트리뷰터의 Local 저장소로 clone 합니다.

Local 저장소에 아래 명령어를 입력합니다. (복사한 내 remote 저장소 URL 입력)

[vagrant@localhost git-akasiman-pr-sender]$ git clone https://github.com/akasima-pr-sender/Pull-Request-Test.git
 Cloning into 'Pull-Request-Test'...
 remote: Counting objects: 3688, done.
 remote: Compressing objects: 100% (2594/2594), done.
 remote: Total 3688 (delta 867), reused 3688 (delta 867)
 Receiving objects: 100% (3688/3688), 7.45 MiB | 1.47 MiB/s, done.
 Resolving deltas: 100% (867/867), done.
[vagrant@localhost git-akasiman-pr-sender]$ ls
 Pull-Request-Test
 Pull-Request-Test

clone한 디렉토리로 이동 합니다.

[vagrant@localhost git-akasiman-pr-sender]$ cd Pull-Request-Test

PR 보내기 준비

XpressEngine 저장소는 develop branch로 PR 보내는 것을 원칙으로 합니다. master branch로 PR을 보내면 받지 않습니다.
Pull-Request-Test 저장소에서도 develop branch에 PR을 보내기 위한 연습을 하겠습니다.

local 저장소의 branch를 develop branch로 변경합니다.

[vagrant@localhost Pull-Request-Test]$ git branch -a
* master
  remotes/origin/HEAD -> origin/master
  remotes/origin/develop
  remotes/origin/master
[vagrant@localhost Pull-Request-Test]$ git checkout develop
 Branch develop set up to track remote branch develop from origin.
 Switched to a new branch 'develop'
[vagrant@localhost Pull-Request-Test]$ git branch -a
* develop
  master
  remotes/origin/HEAD -> origin/master
  remotes/origin/develop
  remotes/origin/master

이제 PR을 보내기 위한 준비를 마쳤습니다.
파일을 임의로 수정하고 PR 작성하는 예시를 보겠습니다.

PR 보내기

local 저장소의 수정사하을 remote 컨트리뷰터 저장소로 보내기

develop branch에서 PR을 보내기 위한 수정을 처리하게 되면 PR 보낼 때 문제가 발생하게 됩니다.
발생할 문제에 대해서는 뒤에 언급 하도록 하겠습니다. develop branch로 PR을 보내므로 develop branch에서 새로운 branch를 생성합니다.

[vagrant@localhost member]$ git checkout -b develop-prtest1
 Switched to a new branch 'develop-prtest1'

develop-prtest1은 임의로 정한 branch 이름입니다. 개인의 취향에 맞게 작성하시면 됩니다.

Pull-Request-Test/modules/member/member.view.php를 수정하고 commit 합니다. (수정내용은 중요하지 않습니다. PR작성을 어떻게 하는지 확인하기 위한 문서이므로 수정 내용에 대한 언급은 않겠습니다.)

[vagrant@localhost Pull-Request-Test]$ vi modules/member/member.view.php
[vagrant@localhost Pull-Request-Test]$ git add modules/member/member.view.php
[vagrant@localhost Pull-Request-Test]$ git commit -m "member view 수정"
[develop-prtest1 af7c490] member view 수정
 1 file changed, 2 insertions(+)

수정 변경 사항을 내 저장소로 push 합니다.

[vagrant@localhost Pull-Request-Test]$ git push origin develop-prtest1
 Username for 'https://github.com': akasima-pr-sender(GitHub ID)
 Password for 'https://akasima-pr-sender@github.com': (GitHub PassWord)
 Counting objects: 9, done.
 Delta compression using up to 2 threads.
 Compressing objects: 100% (5/5), done.
 Writing objects: 100% (5/5), 446 bytes | 0 bytes/s, done.
 Total 5 (delta 4), reused 0 (delta 0)
 To https://github.com/akasima-pr-sender/Pull-Request-Test.git
 * [new branch]      develop-prtest1 -> develop-prtest1

컨트리뷰터의 remote 저장소에 develop-prtest1 branch가 생성되고 commit 내용이 push 되었습니다.

remote 컨트리뷰터 저장소의 수정 내용을 remote 원본 저장소로 보내기 (Pull Request)

이제 remote 원본 저장소로 PR을 보냅니다.
컨트리뷰터의 remote 저장소인 GitHub 페이지로 이동합니다.
GitHub에서 PR보낼 commit이 있는 branch로 이동합니다.

이동 페이지에서 compare & pull request를 클릭합니다.

보내는 저장소와 받는 저장소를 확인합니다.

akasima-pr-sender 저장소의 develop-prtest1 branch 의 수정된 내용을 akasima저장소의 develp branch로 보내야 합니다. 현재 akasima 저장소의 master branch로 보내도록 되어 있으므로 branch를 develop으로 변경합니다.

PR보낼 제목 및 내용을 작성하고 하단에 수정 내용및 PR에 포함된 commit을 확인합니다. PR 보낼 commit이 맞는지 수정된 내용이 정상적으로 포함 되었는지 확인합니다.

Create Pull Request를 클릭하여 PR을 보냅니다.

처리 후 akasima의 Pull-Request-Test 저장소로 이동됩니다.

작성 후 branch 및 보낸 수정사항을 확인합니다.

PR 작성 후 같은 이슈에 대한 추가적인 코드 개선

PR을 작성 후 컨트리뷰터가 추가적인 오류나 코드 개선에 대해서 PR을 수정할 경우가 있습니다. 이때는 RP을 보낸 branch(develop-prtest1 branch)에서 commit, push하면 됩니다.

[vagrant@localhost Pull-Request-Test]$ vi modules/module/module.controller.php
[vagrant@localhost Pull-Request-Test]$ git add modules/module/module.controller.php
[vagrant@localhost Pull-Request-Test]$ git commit -m "module 모듈에 flag 추가"
[develop-prtest1 2cf4077] module 모듈에 flag 추가
 1 file changed, 2 insertions(+)
[vagrant@localhost Pull-Request-Test]$ git push origin develop-prtest1
 Username for 'https://github.com': akasima-pr-sender(GitHub ID)
 Password for 'https://akasima-pr-sender@github.com': (GitHub PassWord)
 Counting objects: 9, done.
 Delta compression using up to 2 threads.
 Compressing objects: 100% (5/5), done.
 Writing objects: 100% (5/5), 487 bytes | 0 bytes/s, done.
 Total 5 (delta 4), reused 0 (delta 0)
 To https://github.com/akasima-pr-sender/Pull-Request-Test.git
 af7c490..2cf4077  develop-prtest1 -> develop-prtest1
[vagrant@localhost Pull-Request-Test]$

이렇게 PR을 작성하는 방법에 대해서 알아 봤습니다.

PR은 컨트리뷰터 저장소의 특정 branch를 원본 저장소의 브랜치로 보냅니다.
간혹 commit을 보낸다고 생각하시고 이미 PR을 보낸 branch에서 다른 주제를 수정해서 보내는 경우를 볼 수 있습니다.
이렇게 작성 할 경우 이미 있던 PR에 해당 commit이 추가되어 수정 내용을 알 수 없게 됩니다.
이와 같은 이유로 develop branch에서 PR을 보내지 않습니다.