오전 스크럼을 하다가 조원분이 issue 템플릿 사용 및 커밋, pr로 issue 닫는 법을 알려주셨다.
개인과제때 사용해 봤는데 좋은 것 같아서, 이번 팀프로젝트에 적용해 보았다.
1. Issue Template 생성
pr 템플릿 만드는법과 비슷하게 .github 밑에 파일을 생성하는데, 바로 마크다운 파일을 생성하는 것이 아니라 ISSUE_TEMPLATE 폴더를 생성한다.
이 밑에
- 기능 Issue 템플릿
- 버그 Issue 템플릿
등 여러 템플릿을 생성할 수 있다.
2. Issue 작성
Issue 탭에 가서 Issue 작성하기를 누르면 템플릿을 고를 수 있는데, 우리팀은 아직 기능 개발 중이라 기능 개발 이슈만 작성해봤다.
템플릿이 적용된 모습을 볼 수 있다.
여기에 이제 이렇게 체크리스트를 만들어주면 진행상황을 확인할 수 있다.
저 #8 과 같은 번호 표시는 일단 확인해두기.
첫날 와이어프레임을 작성하고 토의한 부분에 대해서 기능 개발 Issue를 쭉 정리해 놓은 모습이고, 팀원들이 체크리스트에 표시하며 과업 진척도를 공유할 수 있다.
물론 저 안의 내용들은 팀원들도 편집이 가능하기에 유연하게 사용할 수 있다.
이슈별로 담당자(Assignee), 라벨, 마일스톤 등을 선택 가능하다.
3. Commit, PR로 Issue Close하기
열린 Issue는 직접 닫을 수도 있지만 커밋이나 PR로도 닫을 수 있다.
아까 위에서 확인해 두라고 한 것처럼, 모든 이슈나 PR등은 각자 번호를 가지고 있는데, 이 번호의 이슈 닫음을 커밋이나 PR 문서에 명시해주면 된다.
위와 같이 close #14 를 작성하고 커밋하면,
이렇게 닫힘을 볼 수 있다.
번호를 꼭 외우지 않아도, 깃허브에서 문서 작성시에 #을 누르면 풀다운 목록이 여러개 떠서 선택할 수도 있다.
참고로 저
close외에도fixes,resolves등 여러가지 명령어가 있다. 이런건 또 나중에 쓰면서 알아보도록 하기
