[Github] 깃허브 프로젝트 기반의 온라인 코드리뷰 순서

깃허브를 기반으로 한 온라인 코드리뷰 순서

*로컬 저장소 = 내 PC (위 이미지의 주황색 영역)

*원격 저장소 = 깃허브 저장소 (javajigi/java-racingcar)

*프로젝트 원격저장소 = 내가 참여하고 싶은 깃허브 원격저장소를 뜻함. (code-squad/java-racingcar)

*origin = 내 원격 저장소를 뜻함

*upstream = 프로젝트 원격저장소를 뜻함

*로컬 저장소의 메인 브랜치 이름 = 프로젝트 원격 저장소의 내 브랜치 이름

1. 프로젝트 원격저장소에 내 브랜치 생성을 요청한다.

2. 해당 원격저장소를 fork한다.

   • fork : 다른 계정의 원격 저장소를 내 깃허브 계정으로 복사해 온다.
     깃허브 저장소 오른쪽 상단의 Fork버튼을 누르면 된다.

3. fork한 원격 저장소를 로컬 저장소로 clone한다.

   • git clone : 원격 저장소를 로컬 저장소로 복사해 온다.
     원격 저장소를 복사해 오고 싶은 위치로 cd한 뒤 아래 명령을 실행한다.
   • git clone -b 내브랜치이름 --single-branch fork한원격저장소HTTPS주소

4. clone한 로컬 저장소를 열고, 작업을 위한 새 브랜치를 만든다.

   • clone한 위치의 로컬 저장소를 열고, 해당 위치에서 새 브랜치를 만든다.

   • git checkout -b 새브랜치이름: 해당 브랜치를 만듦과 동시에 해당 브랜치로 체크아웃한다.

   • 로컬 저장소의 기본 브랜치는 둔 채, 새 브랜치를 만들어 거기서 작업한 뒤 완성되면 merge하는 방식으로 작업한다. 기본 브랜치에서 직접 작업하지 않는다.

5. 만든 새 브랜치에서 작업 후 add/commit한다.

   • 새로운 버전을 작업하는 단계마다 만들고 커밋하는 것을 반복한다.
   • git add . 또는 git add 파일명
   • git commit -m "커밋메시지"

6. 로컬 저장소에서 작업 한 단위를 마치면, 내 원격 저장소에 push한다.

   • 로컬에서 생성 및 작업한 새 브랜치를 원격 저장소에도 반영한다.
   • git push origin 새브랜치이름

7. 코드리뷰를 받기 위해, 내 원격 저장소에 반영된 새 브랜치를 프로젝트 원격저장소로 pull request를 보낸다.

   • 내 원격 저장소에서 [New pull request]를 누른다.
   • (Open a pull request에서) 프로젝트 원격 저장소의 브랜치(base)는 내 브랜치로 선택한다.
   • 내 원격 저장소의 브랜치(compare)는 새 브랜치(새로 생성 후 작업한 브랜치)로 선택한다.
   • Able to merge를 확인한 뒤 pull request 제목과 내용을 작성해 보낸다.
     pull request를 받은(코드 리뷰를 하는)사람이 참고할 수 있도록 작업한 내용에 대한 설명을 적으면 된다.
   • 코드리뷰를 하는 사람은 해당 pull request의 Files changed에 들어가, 신청자가 작업한 내용을 확인한다. comment, Review summary도 남길 수 있다.
   • 리뷰어로부터 리뷰를 받으면, 해당 브랜치에서 리뷰에 대한 피드백 작업을 계속한다.
     5.로 돌아가서 반복한다.
   • 코드리뷰를 하는 사람은 pull request의 작업내용이 괜찮다고 확인되면 해당 브랜치를 merge한다. 이는 해당 작업을 프로젝트 원격저장소의 내 브랜치에 내 작업 내용을 반영하는 것이다.

8. pull request한 첫 번째 작업이 반영되고 나면 다음 작업을 해야 한다.
   작업을 하기 전, 프로젝트 원격저장소의 내 브랜치에 내 작업내용이 반영된 상태이기 떄문에, 로컬 저장소의 메인 브랜치에도 해당 작업내용이 반영되도록 하는 연결 및 동기화 작업이 필요하다.

   • 먼저 로컬저장소에서 메인 브랜치로 git checkout한다.
   • 로컬저장소는 현재 내 원격저장소에만 연결이 되어 있다.
     로컬 저장소와 프로젝트 원격저장소를 '연결'하는 작업이 필요하다.
     • git remote add upstream 프로젝트원격저장소HTTPS주소 (최초 1회)
     • git remote -v : 로컬저장소와 연결된 원격저장소 내역을 확인할 수 있다.
       origin과 upstream이 둘 다 있는지 확인한다.
       (origin = 내 원격 저장소 / upstream = 프로젝트 원격 저장소)

9. 로컬저장소와 연결된 프로젝트 원격저장소로부터 변경된 작업내용을 가져온다. (동기화)

   • git fetch upstream 내브랜치이름
     : upstream(프로젝트 원격저장소)에서 해당 브랜치를 가져온다.
   • git branch -a로 로컬저장소 메인브랜치, 로컬저장소 새 브랜치, 내 원격저장소 브랜치(remote/origin/..), 프로젝트 원격저장소 브랜치(remote/upstream/..)가 모두 있는지 확인한다.
   • git rebase upstream/내브랜치이름
     : 프로젝트원격저장소(upstream)의 내 브랜치 변경사항을 로컬 저장소의 메인 브랜치로 가져온다.
     (반드시 로컬저장소의 메인 브랜치로 체크아웃한 상태에서 실행해야 함)
     이제 로컬저장소-프로젝트원격저장소 간 동기화 작업이 끝났다.

10. 이제 로컬 저장소에서 4.처럼 새 브랜치를 다시 만들어 다음 작업을 하면 된다.
    작업 후에는 4. 이후 단계를 반복한다