📌 GitHub Issue와 PR로 프로젝트 관리하기
깃허브로 버전 관리를 하는 프로젝트들이 많을 것이다. 최근 진행한 프로젝트에서 깃허브 이슈와 PR, Project 탭을 사용하였는데 굉장히 만족스러워서 기록한다 >.~
✔ 왜 좋았지?
-
작업의 명확성
무자비하게 commit, push를 하다보면 branch를 파서 작업을 하더라도 내가 지금 하고 있는 작업이 프로젝트의 어떤 부분을 하고 있는지? 무엇을 위한 것인지 헷갈린다. 이슈, PR, 프로젝트 탭을 활용하면 내가 맡은 일이 무엇인지 쉽게 파악하고 헷갈리지 않는다. -
프로젝트 진행도 파악
이슈, PR, Project 탭을 연동시켜 이슈(할 일), PR(한 일)을 기반으로 Project 탭에서 프로젝트의 진행도를 파악할 수 있다. -
효율성 up
팀원들끼리 코드 리뷰하고 merge할 때 각자 맡은 역할을 알 수 있고 이로 인해 효율성이 올라간다.
등~~
✔ 어떻게 사용?
default: Issue, PR 템플릿 작성
이슈 템플릿과 PR 템플릿을 작성하여 .github 디렉터리에 추가한다.
추가해놓으면 Issue, PR 생성 때 템플릿이 자동으로 뜬다.
1. 이슈 생성
이슈에 대한 설명, 그에 따른 Task를 적는다. Assignees에 담당자를 지정하고, Label에 작업종류/우선순위를 정한다. Projects에 현재 프로젝트를 지정하고, Milestone에 몇 주차인지 정한다.
이슈를 생성하면 #58 이라는 것처럼 이슈 번호가 부여된다.
2. Branch 명
Branch명은 "feature#이슈번호-작업명" 이런 식으로 정한다.
(ex) git branch -m "feature#58-result-list-api"
3. PR 생성
작업 후 작업 branch에 add, commit, push를 하면 깃허브에서 PR을 띄울 수 있다.
3.1 제목
제목 내용 close #이슈번호를 제목으로 정한다. #이슈번호로 이슈와 PR을 연결하고, close를 그 앞에 써주면 PR이 merge되면 이슈가 자동으로 close 된다!!
=> 이슈(프로젝트에서 할 일)가 닫히면 어떤 작업이 남았는지 깃허브 내에서 확인하기 쉬워짐
+추가로 #58을 누르면 해당 이슈 번호 페이지로 이동한다.
3.2 내용
PR에 동기, 해결 방법, 리뷰어에게 할 말을 남긴다.
Reviews에 승인/리뷰할 팀원들을 지정한다.
Assignees에 담당자를 지정한다.
Labels에 작업 분류를 지정한다.
3.3 코드 리뷰
Files Changed 탭에 가서 바뀐 내용들을 확인하고, approve/review/comment 등을 남긴다.
+추가로 우리 프로젝트에서는 코드 리뷰에 Pn룰을 적용하였다.
4. Project 탭
프로젝트를 만들면 Todo, In Progress, Done, Confirmed로 구분시켜 이슈에 따른 프로젝트의 진행도를 확인할 수 있다.
이슈에 할 일을 적고 PR -> merge 완료 시 이슈가 close 되면, 자동으로 Done으로 옮겨진다!!
아주 Good 👍
