[Git] Issue, Pull Request, Code Review 사용하여 협업 (feat. PR 승인 후 해야할 일)

Issue, Pull Request, Code Review 사용하여 협업

(feat. PR 승인 후 해야할 일)

---

0. git 레퍼지토리 연결

1. Issue

2. Pull Request

3. PR 승인 후 해야할 일

---

0. git 레퍼지토리 연결

지금은 협업 기능을 공부할 레퍼지토리를 만들어주려고 합니다.

협업 기능만 알아가고 싶을 경우 이 과정은 넘어가셔도 좋습니다.

 

저는 이때까지 프로젝트를 만들고 커밋을 하면서 동시에 레퍼지토리를 만들면서 커밋을 진행했습니다.

그래서 이번에는 레퍼지토리를 먼저 만들고 프로젝트를 연결해보았고, 방법은 아래와 같습니다.

 

 

1. Issue

프로젝트에 기능이나 코드 또는 설정 등을 추가하고 커밋을 하고 싶을 때, Issue를 등록할 수 있습니다.

Issue에는 왜 이 코드가 필요한지, 이 코드의 목적이 무엇인지 등의 배경과 목적을 알 수 있어서 나중에 이 코드가 왜 추가/변경 되었는지를 알 수 있습니다.

 

 

레퍼지토리의 Issues에 들어가서 New issue를 클릭해줍니다.

 

 

코드 변경에 대한 제목과 내용을 작성할 수 있습니다.

이슈에 대한 설명은 팀원들과 함께 정한 템플릿을 활용하여 작성할 수 있습니다.

그 후 Create 버튼을 클릭하면 Issue가 생성됩니다.

 

 

우측에서 이슈에 대한 라벨을 붙여 어떤 이슈인지 한 눈에 알아보기 쉽게 할 수도 있습니다.

 

 

이렇게 이슈가 생성되고 #1 이란 표식을 확인할 수 있습니다.

commit 할 때 커밋 메시지 뒤에 #1을 붙이게 되면 Pull Request를 할 때 어떤 내용에 대한 Pull Request 인지 추적할 수 있게 해줍니다.

 

2. Pull Request

이제 코드에 대한 변경 사항을 커밋하고 Pull Request를 해봅시다.

 

 

가장 처음 init이 된 프로젝트 파일을 git clone으로 가져오셨을 경우 자신의 브랜치를 만들고 거기에서 작업을 하실겁니다.

git checkout -b 브랜치명의 명령어를 입력하여 브랜치를 생성하면서 그 브랜치로 이동을 해주고 git branch를 통해 현재 브랜치 위치를 확인해줍니다.

 

 

그 후 커밋을 진행하고 커밋 메시지에는 #1을 붙여 Issue로 추적 가능하게 해줍니다.

 

 

위의 화면처럼 #1에 마우스를 가져다대면 이슈에 대한 내용을 확인할 수 있습니다.

 

 

Compare & pull request 버튼이 생성됩니다. 이 버튼을 누르게 되면 아래와 같은 화면이 뜹니다.

 

 

compare는 합치고 싶은 브랜치, base는 합칠 브랜치에 대한 설정을해줍니다.

PR에 대한 제목과 내용을 설정할 수 있고, 내용에는 팀원들과 함께 정한 템플릿을 활용하여 작성할 수 있습니다.

변경 이전 내용과 변경 이후 내용 등을 작성하고 Create pull request를 합니다.

 

 

현재는 규칙이 없기 때문에 혼자서 Merge pull request를 진행할 수 있지만 팀원들과 협업할 때에는 규칙을 정해서 코드 리뷰나 확인을 받은 후 Merge를 할 수 있도록 정하면 됩니다.

 

 

Merge를 해주면 test에 작성한 내용이 main에도 반영되게 됩니다.

그 후 해결이 된 Issue는 Close 해주면 됩니다.

 

3. PR 승인 후 해야할 일

본인의 PR이 승이 되었을 경우에는 원래 작업을 계속하면 되지만 다른 사람의 PR이 승인 되었을 경우에는 꼭 해야할 일이 존재합니다.

다시 프로젝트로 돌아가봅시다.

 

 

다른 사람이 변경한 코드가 main으로 합쳐지게 되었으니까 그 코드를 합치기 위해서는 pull을 해줘야합니다.

현재의 작업중인 브랜치에서 pull 해주게 되면 PR 이전의 코드가 들어있기 때문에 main으로 이동해서 pull 해준 후 작업하던 브랜치로 돌아와서 pull 해주면 됩니다.

 

 

제 깃허브의 현재 상황은 이렇습니다.

항상 Commit에만 100% 이었는데 다른 기능들을 사용하면 이렇게 분포가 됩니다.

위의 기능을 사용해서 원활하게 협업 할 수 있으면 좋겠습니다.

---

문제가 있으면 댓글 남겨주세요 !

피드백은 언제나 환영입니다 <3