Github Pull request 사용법

천우산__ ㅣ 2023. 3. 21. 21:58

팀 단위로 개발 프로젝트를 진행하는 경우 하나의 메인 저장 공간을 두고

여러 사람들이 각자 자신의 저장 공간에 작업한 후, 메인 저장 공간에 반영 요청 하는 과정(pull requests)을 원활하게 하기 위해

아래 몇 단계의 작업을 기억해 두면 도움이 될 것 같다.

 

1. 저장소 fork 하기

상단 이미지와 같이 함께 작업할 github 저장소로 접속하여 fork 버튼 클릭

그 후 본인 github 저장소를 확인하면 같은 이름의 저장소가 생긴 것을 확인 할 수 있다.

 

<저장소 복사 확인>

 

이후 내 github로 복사한 저장소를 로컬 폴더로 옮겨주는 작업이 필요하다.

 

git clone <github https 저장 공간 주소>

 

복제가 완료되면, 저장소 이름의 폴더가 생성되는데, 해당 폴더 안에서 작업을 진행하면 된다.

 

<git clone 이후 복사된 폴더에 test.py 생성한 후의 vscode 화면>

작업을 진행하면, 상단 이미지와 같이 변경된 개수만큼 숫자가 증가하는데,

표기된 곳 혹은 명령어 입력을 통해 내 github 저장소에 반영시키고 싶은 파일을 추가할 수 있다.

 

위 이미지에서 표기된 영역의 버튼을 누르거나, 아래 명령어로 추가가 가능하다.

git add <파일 이름> # 여기서는 git add test.py

 

만약, 다수의 파일을 작업하였으며, 모든 작업 내용을 github 저장소로 보내고 싶다면 아래와 같이 입력하면 된다

git add . #신규 생성, 삭제 등 변경 내용을 모두 반영하길 원할 때

 

<git add 반영된 모습,  Changes 에서 Staged Changes 로 이동>

 

위의 내용까지 진행한 경우, github 저장소에 반영을 요청을 위해 한 단계의 작업이 더 필요하다.

 

vscode 에서 진행하는 경우

- message 창에 commit 내용 입력 > commit 버튼 클릭

 

명령어로 진행하는 경우, 아래와 같이 입력한다.

git commit -m "커밋 메세지"

 

여기까지는 내 로컬 PC -> 내 github 저장소로 변경 사항을 적용시킨 것으로,

추가적으로 내 github 저장소 -> 프로젝트 github 저장소로 변경 사항을 적용해달라는 요청을 진행해야 한다

 

하지만 현재 내 PC에는 내 github 저장소와 연결되어있으므로, 팀 프로젝트 폴더에 적용(pull requests) 요청을 하기 위해

현재 연결중인 내 github 저장소가 어디와 연결되는지 먼저 설정해야 하며, 명령어는 아래와 같다.

 

git remote add upstream <팀 프로젝트 저장 주소>

 

프로젝트 연결이 완료되었으면, vscode extension 버튼을 누른 후

"github Pull Requests and Issues" 를 다운 받는다.

 

다운이 완료되면 vscode 좌측 하단에 고양이 모양의 아이콘이 생기는데, 이곳에서 pull requests 진행이 가능하다.

 

<하단 이미지 좌측, Github Pull Resquests 아이콘 및 pull requests 요청을 위한 버튼 표기 >

 

요청하는 버튼을 누르면 아래와 같이 화면이 변경된다.

 

여기서 확인해야할 사항은 상단 Merge Changes From 과 Into 인데,

Merge Changes From : 반영을 요청하는 저장소 (내 저장소)

Into : 반영을 요청 받는 저장소 (프로젝트 보관 저장소)

로 기억하고 있으면 좋다.

 

요청 한 pull requests 가 반영되면, 개인 github 저장소로 이동  동기화 버튼 클릭하여 변경 사항을 받아 온다.

이후 로컬에서 작업하기 전, 반드시 진행해야 하는 사항이 있는데

 

1. 내 PC가 알고 있는 내 github 저장소의 상태와 실제 github 저장소의 상태를 비교하고

2. 내 PC로 github 저장소의 변경 사항을 반영해주는 작업을 거친 이후에 작업을 시작해야 한다.

 

git fetch origin #내 github 저장소의 변경 내역 확인
git pull origin  main #내 로컬 저장소 (vscode) 로 변경사항 반영

 

'Etc > Github' 카테고리의 다른 글

[Github] Github Action 으로 CI / CD 적용하기  (0) 2024.03.11