Github 템플릿 사용해보기

Github 템플릿이란 Github에서 제공해주는 템플릿 기능으로 이슈, PR 등을 생성할 때 틀을 제공한다.

템플릿이 없다면, 이슈와 PR을 작성할 때 가이드라인 없이 공백으로부터 내용들을 작성해야 한다.

Github 템플릿을 적용해둔다면 템플릿을 통하여 가이드라인을 제공하고 이에 맞춰 내용들을 작성하게 된다.

이를 통해 팀원 또는 다른 사람들이 이슈, PR 작업을 편리하게 진행할 수 있게 되고 의사소통 또한 매우 쉬워진다.

 

Github 템플릿 사용하기

원하는 레포지토리의 Settings를 누른 뒤 하단의 Set up templates 초록색 버튼을 클릭한다.

 

3가지 중 하나를 선택할 수 있는데, 필요에 따라 모든 템플릿을 추가해도 된다.

먼저 Feature request 템플릿을 추가한 뒤 우측 상단의 Propose changes를 누른다.

 

이제 이슈를 생성하려 하면 다음과 같이 Feature request와 Blank issue 중 하나를 선택할 수 있을 것이다.

 

Feature request를 누르면 위와 같이 템플릿이 자동으로 적용된다.

이어서 기본값으로 제공되는 템플릿을 수정해보자.

먼저 처음에 설정했던 화면에서 쉽게 편집을 진행할 수 있다.

preview를 연 뒤 수정 버튼을 눌러준다.

 

이름, 설명, 내용 등 모든 부분을 원하는 대로 수정할 수 있다.

 

또는 .github/ISSUE_TEMPLATE 폴더에 있는 feature_request.md를 직접 편집해 수정이 가능하다.

 

 

참고로 .github/issue_template.md를 입력하는 경우 old version이라는 안내 문구가 나오며 적용되지 않는다.

ISSUE_TEMPLATE 폴더를 만들고 그 하위에 md문서들을 작성해야 한다.