GitHub Templates

이 프로젝트에서는 이슈 생성과 PR 작성을 위한 표준화된 템플릿을 제공합니다.

📋 이슈 템플릿

✨ Feature Request (feature-request.yml)

새로운 기능을 요청할 때 사용하는 템플릿입니다.

사용 시기:

• 새로운 기능 추가 요청
• 기존 기능의 확장
• 새로운 API 엔드포인트 추가

포함 정보:

• 기능 설명
• 작업할 내용 (체크리스트)
• 참고 자료

---

🔧 Refactoring (refactoring.yml)

코드 구조 개선 및 리팩토링을 위한 템플릿입니다.

사용 시기:

• 코드 구조 개선
• 성능 최적화
• 중복 코드 제거
• 디자인 패턴 적용

포함 정보:

• 리팩토링 대상
• 리팩토링 유형 (드롭다운)
• 우선순위 (드롭다운)
• 기대 효과
• 작업할 내용 (체크리스트)
• 사전 체크리스트
• 참고 자료

---

🐛 Bug Report (bug-report.yml)

버그 신고 및 문제 해결을 위한 템플릿입니다.

사용 시기:

• 시스템 오류 발견
• 예상과 다른 동작
• 성능 문제
• UI/UX 문제

포함 정보:

• 버그 설명
• 재현 방법 (단계별)
• 기대했던 동작 vs 실제 동작
• 버그 심각도 (드롭다운)
• 영향 범위 (드롭다운)
• 스크린샷/로그
• 환경 정보
• 추가 정보
• 확인 사항 (체크박스)
• 임시 해결방법

---

📄 PR 템플릿

Pull Request Template (pull_request_template.md)

모든 Pull Request에 자동으로 적용되는 템플릿입니다.

포함 섹션:

• PR 요약: 목적과 주요 변경사항
• 관련 이슈: 이슈 링크
• 변경 사항: 체크박스 형태의 변경 유형
• 기술적 변경 사항: 상세한 기술적 내용
• 테스트: 테스트 관련 정보 및 방법
• 성능 영향: 성능에 미치는 영향
• 보안 체크리스트: 보안 관련 확인사항
• 데이터베이스 변경: DB 스키마 변경 여부
• 호환성: 이전 버전과의 호환성
• 문서 업데이트: 문서 관련 업데이트
• 배포 고려사항: 배포 시 주의사항
• 스크린샷: UI 변경 시 before/after 이미지
• 리뷰 포인트: 특별히 확인이 필요한 부분
• 체크리스트: PR 제출 전 확인사항
• 추가 메모: 기타 전달사항

---

📝 사용 방법

이슈 생성 시

1. GitHub에서 "New Issue" 클릭
2. 적절한 템플릿 선택
3. 템플릿에 따라 정보 입력
4. 적절한 라벨 추가
5. 담당자 지정 (필요시)

PR 생성 시

1. GitHub에서 "New Pull Request" 클릭
2. 자동으로 템플릿이 로드됨
3. 템플릿에 따라 정보 입력
4. 적절한 라벨 및 리뷰어 추가
5. Draft PR 또는 Ready for review 선택

---

🏷️ 라벨 가이드

이슈 라벨

• feature: 새로운 기능 추가
• bug: 버그 수정
• refactoring: 코드 구조 개선
• improvement: 기존 기능 개선
• documentation: 문서 관련
• performance: 성능 관련
• security: 보안 관련
• testing: 테스트 관련

우선순위 라벨

• priority/high: 높은 우선순위
• priority/medium: 중간 우선순위
• priority/low: 낮은 우선순위

상태 라벨

• status/in-progress: 진행 중
• status/blocked: 차단됨
• status/ready: 준비 완료
• status/review: 리뷰 중

---

💡 팁

1. 이슈 작성 시: 가능한 한 구체적이고 상세하게 작성하세요.
2. PR 작성 시: 리뷰어가 이해하기 쉽도록 변경 이유와 방법을 명확히 설명하세요.
3. 체크리스트 활용: 템플릿의 체크리스트를 빠짐없이 확인하세요.
4. 스크린샷 첨부: UI 관련 변경사항은 스크린샷을 첨부하면 리뷰에 도움이 됩니다.
5. 라벨 활용: 적절한 라벨을 사용하여 이슈와 PR을 분류하세요.