Issue Guide

🗂️ Issue Guide

이 문서는 SMOOTH 프로젝트에서 이슈를 문서 및 작업 단위 관리 도구로 활용하는 방법을 정리합니다.
Epic → User Story → Task 계층 구조를 기반으로 하며, 이슈를 통해 개발 기록과 산출물을 체계적으로 남깁니다.

---

📌 Epic Issue

• 이슈 제목: [Epic-번호] 제목
• 역할: 상위 목표 단위 (기능/서비스/모듈 단위)
• 브랜치 네이밍: epic/[epic-name]
• 내용: Epic 목표, 하위 User Story 목록, 진행률, 타임라인, 의존성

📑 템플릿:

## 🎯 Epic 목표
[Epic의 전체적인 목표와 범위]

## 📋 User Stories
- [ ] US X.1: [제목] - #[이슈번호]
- [ ] US X.2: [제목] - #[이슈번호]

## 🔄 Progress
- 총 User Stories: X개
- 완료: 0개
- 진행률: 0%

## 🗓️ Timeline
- 시작일: YYYY-MM-DD
- 목표 완료일: YYYY-MM-DD

## 🌿 Branch
epic/[epic-name]

## 📌 Dependencies
- 선행 Epic: #[번호]
- 관련 Epic: #[번호]

---

📌 User Story Issue

• 이슈 제목: US 번호: 제목
• 역할: 사용자 요구사항 정의 및 기능 단위 관리
• Acceptance Criteria(완료 조건), Tasks(세부 작업), Epic 연결 필수

📑 템플릿:

## 📝 User Story
As a [사용자 역할]
I want [원하는 기능]
So that [목적/이유]

## ✅ Acceptance Criteria
- [ ] AC1: 구체적인 완료 조건
- [ ] AC2: 구체적인 완료 조건

## 🔧 Tasks (Commits)
- [ ] T-X.X.1: 태스크 설명 - #[이슈번호]
- [ ] T-X.X.2: 태스크 설명 - #[이슈번호]

## 🌊 Epic
Epic X: [Epic 이름]

## 🎯 Sprint
Sprint [X주차]

## 📌 Related
- Epic Issue: #[번호]
- Related Issues: #[번호]

---

📌 Task Issue (Optional)

• 이슈 제목: T 번호: 제목
• 역할: User Story의 구체적 구현 단위
• Definition of Done 포함 → 구현, 테스트, 리뷰 완료 여부

📑 템플릿:

## 🔧 Task 설명
[구체적인 작업 내용]

## ✅ Definition of Done
- [ ] 코드 구현 완료
- [ ] 테스트 작성 완료
- [ ] 코드 리뷰 완료

## 🌊 Parent Feature
Feature: #[User Story 이슈 번호]

## 💻 기술 스택
- React
- Spring Boot
- AWS Lambda

---

📌 활용 방식

• 문서의 시작점

  • 설계안, 기획 배경, 목표 등은 GitHub Issue로 먼저 작성합니다.
  • Epic → User Story → Task 단계로 구분해 작성하면 추적이 용이합니다.

• 개발 단계 추적

  • 각 Task는 커밋과 연결 (T번호 표기)하여 개발 과정을 이슈에서 직접 추적합니다.
  • User Story와 Epic은 진행률(체크리스트)로 관리합니다.

• 산출물 기록

  • 최종 결과물(코드/테스트/리뷰)은 이슈에 남겨 기록성을 확보합니다.

📌 즉, 이슈는 단순한 작업 카드가 아니라 기획 → 개발 → 기록 전 과정을 아우르는 문서 도구로 활용됩니다.