Git hub Issue template 만들기

API 단위별로 Issue를 관리하면

해당 API 기능에 대해 Todo List를 관리하기 좋고, 브랜치를 이슈 번호로 관리하며 체계적인 개발환경을 구축하기 좋다.

그래서 그런 git hub issue를 생성할때 쓰기 좋은 템플릿 만드는 법을 정리해보았다.

 

먼저 git hub에서 repository 접속 후 settings를 클린한다.

settings에 들어와서 스크롤을 조금만 내리면 Set up templates 를 볼 수 있고, 해당 버튼을 클릭한다. 

 

클릭하면 아래와 같이 Add Template : select 클릭 후 Custom issue template 를 클릭하면 아래와 같이 템플릿을 만들 수 있는 공간이 생긴다. 저 연필 모양의 편집 버튼을 눌러서 만들어둔 템플릿을 넣어주면 된다! 

이때 주의할점 *** 템플릿 수정 후 오른쪽의 Propose changes 버튼을 꼭!!! 눌러주어야 저장이 된다. ***

 

아래는 미리 작성해둔 템플릿 예시이다.

---
name: "🧪 테스트 이슈"
about: 
title: "[test] 테스트 명칭"
labels: ""
assignees: ''

---

## ⚙️ 테스트 종류
어떤 종류의 테스트를 진행할 예정인가요? (예: 기능 테스트, 성능 테스트, UI 테스트 등)

## 🎯 테스트 목표
이번 테스트를 통해 무엇을 확인하고 싶은가요?

## ✅ Todo
- [ ] --
- [ ] --
- [ ] --
- [ ] --

 

---
name: "✨ 기능 요청"
about: 
title: "[feature] 기능 요약"
labels: ""
assignees: ''

---

## 🚀 기능 설명
어떤 기능을 추가하거나 개선해야 하는지 간단히 설명해주세요.

## 🤔 필요 이유
왜 이 기능이 필요하거나 유용한지 설명해주세요.

## ✅ Todo
- [ ]  ..
- [ ] ..
- [ ] ..
- [ ] ..

---
name: "\U0001F41E 버그 보고"
about: 프로젝트에서 발견된 버그를 보고해주세요.
title: "[bug] 버그요약"
labels: "\U0001F41E BugFix"
assignees: ''

---

## 🐞 버그 설명
버그에 대한 간단한 설명을 작성해주세요.

## 🤔 기대한 결과
정상적으로 동작했을 때 기대되는 결과를 적어주세요.

## 😥 실제 결과
버그로 인해 발생한 실제 결과를 적어주세요.

## ✅ Todo
- [ ] todo
- [ ] todo
- [ ] todo
- [ ] todo

---
name: "\U0001F680 배포 이슈"
about: 배포와 관련된 이슈를 작성해주세요.
title: "[deploy] 배포 환경"
labels: "\U0001F30F Deploy"
assignees: ''

---

## 📌 배포 환경
어떤 환경에 배포할 예정인가요? (예: 개발 서버, 스테이징 서버, 운영 서버)

## 📦 배포 내용
이번 배포에 포함되는 내용을 간략하게 설명해주세요.

## ✅ Todo
- [ ] todo
- [ ] todo
- [ ] todo
- [ ] todo

---
name: "\U0001F4BB 개발 환경 설정 이슈"
about: 개발 환경 설정과 관련된 이슈를 작성해주세요.
title: "[env] 설정 내용"
labels: "⚙ Setting"
assignees: ''

---

## 🔧 설정 내용
어떤 개발 환경을 설정해야 하나요? (예: JDK, IDE, 라이브러리 등)

## 📚 설정 방법
개발 환경을 어떻게 설정할 수 있는지 상세하게 설명해주세요.

## ⚠️ 주의 사항
설정 시 주의해야 할 점이 있다면 명시해주세요.

## Todo
- [ ] todo
- [ ] todo

---
name: "\U0001F4C8 개선 요청"
about: 기존 기능을 개선하거나 최적화할 아이디어가 있다면 작성해주세요.
title: "[enhancement] 개선 사항 요약"
labels: "\U0001F528 Refactor"
assignees: ''

---

## 📈 개선 대상
개선이 필요한 기능이나 모듈을 명시해주세요.

## 🤔 현재 문제
기능이 어떻게 동작하고 있으며, 개선이 필요한 이유를 적어주세요.

## 💡 개선 방안
어떤 식으로 개선할 수 있을지 제안해주세요.

## 📎 추가 참고 자료
관련 링크나 참고할 수 있는 자료가 있다면 첨부해주세요. (선택 사항)