개발 관련/GitHub

[Github] 이슈 템플릿(issue template) 사용하기

아렉스_Arex 2024. 9. 12. 13:44
반응형

안녕하세요 아렉스입니다.

이슈를 통해서 프로젝트 관리를 진행해보셨나요 ?

개인 혹은 팀으로 진행하더라도, 반복되는 문서 작업은 매우 귀찮습니다.

이런 경우에 이슈 템플릿을 사용을 하면, 반복적인 작업을 개선 및 이슈 내용에 대한 일관성을 가질 수 있습니다.

 

파일 확장자로는 .md, .yml 두가지 선택해서 만들 수 있습니다.

github에서 제공하는 기능을 통해 GUI 환경에서 만들 수 있고, 양식과 경로를 알고 있다면, CLI 환경에서 만들고 직접 push 해도 상관없습니당 ㅇㅅㅇ

 

github에서 생성을 위한 경로는 Settings -> General - Features 과 같습니다.

 

 

영어를 몰라도 할 수 있게끔 초록색 버튼으로 클릭을 유도하고있습니다 ㅎㅎ

 

만들어진 이슈 템플릿을 사용한 모습입니다. 

 

 

github 환경을 이용하지않고 직접하고싶다면, 아래 경로로 만들면 됩니다.

.github/issue_template.md - 단일로 사용시

.github/ISSUE_TEMPLATE/issue_template.md - 여러 템플릿 사용시

 

 

블로그 설명에 사용 된 레포지터리 링크도 걸어둘테니, 참고바랍니다

https://github.com/kangddong/Document

 

 

참조 링크

https://docs.github.com/ko/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates

 

문제 및 끌어오기 요청 템플릿 사용 - GitHub Docs

문제 및 끌어오기 요청 템플릿을 사용하면 기여자가 리포지토리에서 문제를 공개하고 요청을 끌어올 때 포함시키도록 하고 싶은 정보를 사용자 지정하고 표준화할 수 있습니다.

docs.github.com