GitHub 협업이 처음인 분을 위한 Github Flow

디퐁·2022년 12월 31일
1
post-thumbnail

당신을 위한 글입니다

Git과 GitHub 사용법은 어느정도 알겠어.
이제 한번 2명 이상과 프로젝트를 진행해보고 싶어.

규칙없이 마구잡이로 하고 싶지는 않고, 또 그렇다고 너무 복잡하게도 하기 싫은데..

'적당히 체계적으로' 협업하는 방법 없을까?

위와 같은 고민을 하고 계신가요? 바로 당신을 위한 글입니다!

어려운 말/도식 사용하지 않고, 스크린샷을 통해 구체적으로 어떻게 사용하는지 보여드리겠습니다.

📐Github Flow

선 요약

  1. '개발할 것'을 잘게 나누어 GitHub 저장소의 Issue로 등록한다
  2. Issue의 번호를 따서 feature/0 브랜치를 생성한다.
  3. 해당 Issue의 작업을 완료하면 Pull Request를 올린다.
  4. 팀 동료들의 Approve를 받고 Merge한다.

1. 개발할 것을 Issue에 등록한다.

GitHub 저장소의 Issue 메뉴로 들어가서 New Issue를 누릅니다.
그러면 아래와 같은 화면이 나옵니다.

필수로 적어야 하는 부분은 오직 할 일 제목 뿐입니다.
나머지 할 일 상세, 누가 담당할 지, 할 일의 종류 부분은 필요에 따라서 사용하시면 됩니다. 꼭 사용하지 않아도 됩니다.

---등록 후---

이슈 번호를 기준으로 브랜치를 생성할 것이기 때문에 이슈번호를 잘 봐두시면 됩니다.

Comment를 남겨서 팀원과 의견을 교류할 수 있고,
마친 할 일은 Close Issue하여 마쳤다고 표시할 수 있습니다.

2. 브랜치를 생성한다

SourceTree, GitHub Desktop, Fork 등 여러분이 사용하는 버전관리 툴에서
feature/이슈번호로 브랜치를 생성합니다.

방금 생성한 이슈의 번호는 1이므로 feature/1로 생성했습니다.

이제 만든 브랜치 내에서 해당 #1 이슈에 대한 개발을 시작하시면 됩니다!

3. 개발 완료 후 Pull Request를 올린다.

feature/n 브랜치를 Push하면 위와 같이 Pull Request 페이지에서 Compare & pull request 버튼을 띄워줍니다.
클릭해줍시다.

위와 같은 화면이 나옵니다.
PR(Pull Request)도 역시 제목만 필수로 적으면 됩니다.

다만 Review 기능을 통한 상호 코드리뷰는 같이 사용해보시는걸 권해드립니다.

closes #1처럼 closes 키워드를 활용하면 편리합니다.
해당 PR이 Merge되면 #1번 이슈까지 자동으로 Close 해줍니다.

---등록 후---

등록하면 위와 같은 화면이 나옵니다.
동료의 Approve를 모두 받고 난 후 Merge pull request를 눌러 main 브랜치에 반영하면 됩니다.

오른쪽 아래를 보면 Development 라는 메뉴가 있는데
closes #1을 PR 본문에 넣음으로써 자동으로 #1 이슈와 연동된 것을 확인하실 수 있습니다.

4. 다른 동료들의 Pull Request를 Review해준다.


누군가가 Reviewers에 여러분을 추가하면
PR 페이지 상단에 스크린샷처럼 'Add your review' 버튼이 활성화됩니다.

특정 코드 행에 리뷰 커멘트 남기기

리뷰를 달 특정 코드 행에 마우스를 올리면 + 버튼이 나옵니다.

  • 버튼을 눌러서 특정 행에 대해 리뷰를 남기실 수 있어요.

Add single comment는 리뷰와 무관하게 해당 코드 행에 대해 단순 커멘트로 처리되고
Start a review로 하게되면 Review와 묶인 커멘트로 처리됩니다.

둘 사이에 사용 상 큰 차이는 없습니다.

Approve 또는 Change Requested 남기기

모든 코드 행 리뷰를 마치면
Approve 또는 Request changes를 선택해 리뷰를 게시합니다.

5. Approve 받은 내 PR을 Merge한다.

이런 식으로 내 PR에 Approve를 모두 받았다면
Merge pull request를 클릭해서 main 브랜치에 병합해주면, 하나의 이슈에 대한 모든 작업이 끝납니다.

6. 끝!

이게 전부입니다. 글로만 봤기 때문에 아직까지는 눈이 번뜩 뜨이는 느낌은 없을겁니다.
하지만 정말 이 정도만 해도 적당히 체계적인 협업을 하는 데엔 아주 충분합니다. 장담합니다.

이제 이 글을 참고해서 팀원과 협업하시면서 감을 찾아가보세요.
몇 번만 해보시면 금세 적응하고 '오, 뭔가 나 제대로 개발하고 있는거같아!' 하는 뿌듯한 느낌을 받으실겁니다.

0개의 댓글