깃허브 이슈 템플릿 작성하기

이번에 새로운 프로젝트를 시작하면서 깃허브 레포지토리를 생성할 일이 있었는데, 혼자 쓰는 것이긴 하지만 깃허브 이슈 템플릿을 미리 작성해두면 통일성을 기할 수 있어 편할 것 같아 이번기회에 직접 작성해보기로 했다.

 

1. github 레포지토리 > Settings > General 탭에서 Set up Templetes

 

 

2. 드랍다운에서 커스텀 템플릿 선택

 

3. Preview and edit 클릭

 

4. 연필 모양 수정버튼 클릭

제목과 부제목을 수정한다. 이것은 이슈에 들어가면 가장 먼저 보일 것이라 잘 띄게 하는게 좋겠다. 엄청 큰 프로젝트의 경우 템플릿이 여러개가 있는지는 모르겠지만...

 

5. 마크다운으로 내용 작성

다른 분들은 더 많은 내용을 썼지만, 혼자 쓰는 레포다보니 이슈가 프로젝트를 기록하는 이상의 역할을 하진 않을 듯하다. PM이 있긴 하지만 백엔드 프로젝트까지 관여하진 않을 듯하니. 그래도 꾸준하게 쓰는 것은 나중에 프로젝트를 마치고 나면 큰 힘이 된다. 체계적으로 프로젝트를 관리하시는 분들을 보면 항상 대단하다고 느꼈다. 게으른 나로서는 어떻게 저렇게까지 깔끔하게 프로젝트를 정리해놓았는지 존경스럽다. 그래서 이번엔 작은것부터 해보려한다.

 

6. 그리고 필요에 따라 아래에 Assignees, Labels 미리 설정

Labels에는 Milestone도 설정할 수 있다. PM이 직접 관리하는 프로젝트의 경우 좋은 기능일 듯하다. 나는 5개의 라벨만 설정해줬다. 그리고 Propose Changes로 커밋하면 아래처럼 .github/ISSUE_TEMPLATE/ 폴더에 생성한 마크다운 파일이 생성된 것을 확인할 수 있다.

 

7. 템플릿을 사용하여 이슈 작성

아래처럼 설정해 놓은 템플릿을 불러와 이슈를 작성할 수 있게 된다. 

 

여태껏 팀프로젝트를 해왔는데, 혼자 하는데 이정도 규모의 프로젝트는 처음이라 다른 분들이 해준 것들을 내가 찾아가면서 해볼 기회가 생겼다. 물론 레포를 혼자 쓰기에 이 이상의 설정은 필요 없겠지만 그럴수록 더 깨끗하게 써야할 듯하다. 이번 프로젝트는 도커를 열심히 배워서 배포 파이프라인과 모니터링에 힘써 더 완성도 높은 백엔드 서버를 구축해보려 한다. 곧 Jenkins를 프로젝트에 적용해보고 다시 글을 쓰겠다.