GitHub Issue 표준 템플릿

 

 

 

GITHUB ISSUE DOCUMENTATION SYSTEM

Engineering Workflow

개발 효율을 극대화하는 GitHub Issue 표준 템플릿

포스트 요약: 명확한 문제 정의와 작업 범위를 설정하여 협업의 병목을 해결하는 고도화된 이슈 관리 양식을 제안합니다.

이슈 문서 운영 원칙

[ Protocol: Issue Registry ]

■ 핵심 정보 우선: 태그에 체크한 항목만 상세 내용(details)을 열어 가독성을 확보합니다.

■ 제목 컨벤션: [Type] 요약 규칙을 적용하여 목록에서 목적을 즉시 파악합니다.

GitHub Issue 표준 템플릿 (Full)

아래 마크다운 전문을 .github/ISSUE_TEMPLATE 파일에 그대로 복사하여 사용하세요.

 

 

 

# [ Issue / Task ]

> [ Title Convention ]
> **[Type] 간단 요약**
> 예) `[Bug] STT 무음 환경에서 환각 텍스트 생성`
> 예) `[Feature] 민원 자동 분류 결과 신뢰도 표시`

---

## [ TAG: Issue Type ]
- [ ] Bug (버그)
- [ ] Feature (기능 요청)
- [ ] Refactor (리팩토링)
- [ ] Improvement (개선)
- [ ] Infra / DevOps
- [ ] Docs
- [ ] Test
- [ ] Research / Spike

---

## 1. 배경 (Background)
- **현재 상황**: 
- **문제 인식 또는 요구 배경**: 
- **관련 맥락(업무/사용자/운영)**: 

---

## 2. 문제 정의 (Problem)
### 발생 조건 (Bug인 경우)
- **발생 시점**: 
- **발생 위치**: 
- **실행 환경**: 

### 문제 현상
- 실제로 발생하는 현상 기술
- 기대 동작과의 차이 분석

### 영향 범위
- [ ] 사용자 UX / [ ] 기능 동작 / [ ] 데이터 무결성 / [ ] 성능 / [ ] 운영/배포 / [ ] 보안

---

## 3. 목표 (Goal)
- **최종 달성 상태**: 
- **성공 기준 (Done Definition)**: 

---

## 4. 해결 방향 제안 (Solution Proposal)
### 접근 아이디어
- 가능한 해결 방향 및 구조/로직 변경 여부

### 고려 사항
- 기술적 제약 및 UX / 성능 / 운영 측면 고려

---

## 5. 대안 검토 (Alternatives)
- **대안 1**: 
- **대안 2**: 
- **채택하지 않은 이유**: 

---

## 6. 작업 범위 (Scope)
### 포함 범위
- 포함되는 작업 목록: 

### 제외 범위
- 이번 이슈에서 다루지 않는 작업: 

---

## 7. 예상 변경 지점 (Impact Area)
- [ ] Frontend / [ ] Backend / [ ] AI / ML / [ ] DB / [ ] Infra / [ ] 문서

---

## 8. 예상 리스크 (Risk)
- [ ] Low (내부 로직 수준)
- [ ] Medium (기능 동작 변경)
- [ ] High (운영/데이터/호환성 영향)

> ※ High인 경우 반드시 대응 전략 기재

---

## 9. 테스트 전략 (Test Plan)
- **테스트 방식**: [ ] 단위 테스트 / [ ] 통합 테스트 / [ ] 수동 테스트
- **테스트 시나리오 요약**: 

---

## [ Reference Links ]
- 관련 Issue: 
- 관련 PR: 
- 문서 / 참고 자료: 

---

## [ Observations ]
- 특이사항: 
- 결정이 필요한 사항: 

"이슈를 정의하는 데 쓰는 10분이 잘못된 코드를 수정하는 데 쓰는 10시간을 아껴줍니다."

Last Updated: 2026. 03. 17

TOP