[GIT] 효율적인 협업을 위한 GitHub Workflow 정리

들어가며..

아래 내용은 새로운 작업을 시작해 최종적으로 GitHub에 변경 사항을 반영하는 전 과정을 정리한 가이드

 

전체 흐름

1. 새로운 작업에 대한 이슈 생성
2. 해당 이슈에 대한 브랜치 생성 및 작업
3. 변경 사항 커밋 및 푸쉬
4. Github에서 pull request 생성
5. 팀원들의 코드 리뷰 후 merge작업 진행

 

1. 새로운 작업에 대한 이슈 생성

1. 제목 작성
2. 본문 작성
3. 작업을 담당할 사람 설정(Assignees)
4. 작업에 대한 카테고리 설정(Labels)

 

여기서 생성된 이슈 제목 옆에 있는 번호가 이슈 번호 (예: #4)

 

 

 

2. 해당 이슈에 대한 브랜치 생성 및 작업

main이나 develop 브랜치에서 아래 명령어 입력

•  git checkout -b "feat/<이슈번호>-<작업에 대한 요약>" ( 예: feat/#4-docker-cicd )

 

3. 변경 사항 커밋 및 푸쉬

commit

• 커밋 방법은 자유.
• 커밋 메시지를 작성할때 이슈 번호를 꼭 작성 (예: feat: 로그인 기능 구현 (#4) )
• 아래는 GUI를 이용하여 커밋을 진행한 것

 

push

2. 과정에서 생성한 브랜치에 push작업

• git push --set-upstream origin "feat/<이슈번호>-<작업에 대한 요약>" ( 예: feat/#4-docker-cicd )
  • 옵션을 주는 이유는 원격 저장소에 해당 브랜치가 없기 때문

 

 

 

 

4. Github에서 pull request 생성

• 위 작업을 진행한 후, Pull requests 메뉴에 들어가면 pull request 버튼이 보인다.
• Compare & pull request 버튼 클릭

 

 

 

pull request에 대한 내용 작성

1. PR 제목
2. PR 본문
   • 작업사항에는 이슈 번호를 입력(#4)
3. 코드 리뷰를 부탁할 동료 선택(Reviewers)
4. 해당 작업을 한 사람 선택(Asignees)
5. 작업에 대한 카테고리 선택(Labels)

 

 

5. 팀원들의 코드 리뷰 후 merge작업 진행

• 팀원들은 생성된 PR을 보고 리뷰 작성 및 Approve 진행
  • 팀원이 작성한 코드에 질문이 있다면 해당 코드 부분에 댓글을 작성
  • 없다면, "수고하셨습니다" 같은 댓글을 작성하며 approve 진행