[GitHub] Issue Custom Template

김우진·2022년 6월 7일
0

github

목록 보기
1/1

GitHub Issue Template

github를 사용하다 보면 Issue를 참 많이 사용한다. Issue는 작성 방법에 제약이 없지만, 보통 같이 작업하는 사람들끼리 약속하여 형식을 통일해서 사용한다. 그러다 보면 반복적인 내용들이 많게 되는데 github에서는 Issue Template를 제공하여 약속된 반복적인 내용들을 Issue를 생성할 때 template 형태로 제공한다.

  1. github repository의 'Setting' tab의 'Features' 항목을 보면 아래와 같이 Issues에서 Template를 만들 수 있다.
    Setting Tab

  2. 'Set up Templates' 버튼을 누르면 아래와 같은 화면이 뜨는데 이는 등록된 이슈 템플릿이 없기 때문이다. 화면의 'Add template: select'를 누르면 github가 기본으로 제공하는 Bug report template와 Feature request template가 있고 그 외에 직접 template를 만들 수 있는 Custom template도 있다.
    Issue Templates

  3. 우리는 Custom Template를 만들 것이므로 Custom Template를 누르고 Preview and edit를 눌러 팀원들과 약속한 형식으로 Template를 수정해준다. 내용뿐만 아니라 Label, Assignees, Title 등도 Default로 지정할 수 있다.
    edit template

  4. 작성이 완료되었다면 오른쪽 상단의 'Propose changes' 버튼을 누르면 변경 사항을 commit 할 수 있는 창이 뜨고 'Commit changes'를 누르면 Template이 적용된다.
    commit changes

  5. 이제 새 Issue를 작성하면 Custom Template이 나오고 적용되는 것을 확인할 수 있다.

0개의 댓글