diff --git "a/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\260\234\354\204\240.md" "b/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\260\234\354\204\240.md" new file mode 100644 index 00000000..6004c86d --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\260\234\354\204\240.md" @@ -0,0 +1,38 @@ +--- +name: 기능 개선 +about: '기존 기능의 개선 및 확장' +title: "[IMPROVE] " +labels: "✨ IMPROVE" +assignees: '' + +--- + +## ✨ 개선할 기능 + +
+ +## 🏷️ 도메인 (해당하는 것에 체크) +- [ ] 📝 domain:post (게시글) +- [ ] 👤 domain:user (사용자) +- [ ] 🏢 domain:source (테크블로그 출처) +- [ ] 🔍 domain:search (검색) +- [ ] 🔔 domain:notification (알림) +- [ ] 📊 domain:recommendation (추천) +- [ ] 🌐 infra (인프라/배포) + +
+ +## 📌 현재 상태 (AS-IS) + + +
+ +## 🎯 개선 방향 (TO-BE) + + +
+ +## 💡 개선 이유 + + +
\ No newline at end of file diff --git "a/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\265\254\355\230\204.md" "b/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\265\254\355\230\204.md" index 71342f3e..c2ac0d96 100644 --- "a/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\265\254\355\230\204.md" +++ "b/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\265\254\355\230\204.md" @@ -1,8 +1,8 @@ --- name: 기능 구현 -about: '기능 설명 및 구현 ' -title: "[FEAT]" -labels: "\U0001F6E0️ FEAT" +about: '새로운 기능 추가' +title: "[FEAT] " +labels: "🛠️ FEAT" assignees: '' --- @@ -13,3 +13,24 @@ assignees: '' - [ ]
+ +## 🏷️ 도메인 (해당하는 것에 체크) +- [ ] 📝 domain:post (게시글) +- [ ] 👤 domain:user (사용자) +- [ ] 🏢 domain:source (테크블로그 출처) +- [ ] 🔍 domain:search (검색) +- [ ] 🔔 domain:notification (알림) +- [ ] 📊 domain:recommendation (추천) +- [ ] 🌐 infra (인프라/배포) + +
+ +## 📋 상세 설명 + + +
+ +## 💡 참고 사항 + + +
\ No newline at end of file diff --git "a/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\354\210\230\354\240\225.md" "b/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\354\210\230\354\240\225.md" deleted file mode 100644 index 682ebcd3..00000000 --- "a/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\354\210\230\354\240\225.md" +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: 기능 수정 -about: 리팩토링 목적이 아닌 기능 수정 -title: "[FIX} " -labels: "\U0001F527 FIX" -assignees: '' - ---- - -## 🛠️ 수정할 부분 - -
diff --git "a/.github/ISSUE_TEMPLATE/\352\270\260\355\203\200-\354\210\230\354\240\225.md" "b/.github/ISSUE_TEMPLATE/\352\270\260\355\203\200-\354\210\230\354\240\225.md" index 27e16079..ab55dafd 100644 --- "a/.github/ISSUE_TEMPLATE/\352\270\260\355\203\200-\354\210\230\354\240\225.md" +++ "b/.github/ISSUE_TEMPLATE/\352\270\260\355\203\200-\354\210\230\354\240\225.md" @@ -1,12 +1,26 @@ --- name: 기타 수정 -about: '작은 부분 수정 ' -title: "[CHORE]" -labels: "\U0001F3B5 CHORE" +about: '설정, 의존성, 빌드 등 기타 수정' +title: "[CHORE] " +labels: "🎵 CHORE" assignees: '' --- -## 수정 부분과 이유 +## 🔧 수정 내용
+ +## 📝 수정 이유 + +
+ +## 📦 관련 항목 (해당하는 것에 체크) +- [ ] 의존성 업데이트 +- [ ] 설정 파일 변경 +- [ ] 빌드 스크립트 수정 +- [ ] Git 관련 설정 +- [ ] 환경 변수 변경 +- [ ] 기타 + +
\ No newline at end of file diff --git "a/.github/ISSUE_TEMPLATE/\353\246\254\355\214\251\355\206\240\353\247\201.md" "b/.github/ISSUE_TEMPLATE/\353\246\254\355\214\251\355\206\240\353\247\201.md" index e4c0a8b4..9a378237 100644 --- "a/.github/ISSUE_TEMPLATE/\353\246\254\355\214\251\355\206\240\353\247\201.md" +++ "b/.github/ISSUE_TEMPLATE/\353\246\254\355\214\251\355\206\240\353\247\201.md" @@ -1,8 +1,8 @@ --- name: 리팩토링 -about: 클린코드, 디렉토리 구조 변경 -title: "[REFACT] " -labels: "\U0001F31F REFACT" +about: '기능 변경 없는 코드 개선' +title: "[REFACTOR] " +labels: "🌟 REFACTOR" assignees: '' --- @@ -10,3 +10,33 @@ assignees: '' ## ✨ 리팩토링 할 부분
+ +## 🏷️ 도메인 (해당하는 것에 체크) +- [ ] 📝 domain:post (게시글) +- [ ] 👤 domain:user (사용자) +- [ ] 🏢 domain:source (테크블로그 출처) +- [ ] 🔍 domain:search (검색) +- [ ] 🔔 domain:notification (알림) +- [ ] 📊 domain:recommendation (추천) +- [ ] 🌐 infra (인프라/배포) + +
+ +## 📌 현재 코드의 문제점 + + +
+ +## 🎯 리팩토링 방향 + + +
+ +## 💡 기대 효과 +- [ ] 가독성 향상 +- [ ] 성능 개선 +- [ ] 유지보수성 향상 +- [ ] 코드 중복 제거 +- [ ] 기타: + +
\ No newline at end of file diff --git "a/.github/ISSUE_TEMPLATE/\353\254\270\354\204\234-\354\236\221\354\227\205-.md" "b/.github/ISSUE_TEMPLATE/\353\254\270\354\204\234-\354\236\221\354\227\205-.md" deleted file mode 100644 index 9e0e8109..00000000 --- "a/.github/ISSUE_TEMPLATE/\353\254\270\354\204\234-\354\236\221\354\227\205-.md" +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: '문서 작업 ' -about: 문서작업 내용 -title: '' -labels: "\U0001F4DC DOC" -assignees: '' - ---- - -## 📜 작업내용 - -
diff --git "a/.github/ISSUE_TEMPLATE/\353\254\270\354\204\234-\354\236\221\354\227\205.md" "b/.github/ISSUE_TEMPLATE/\353\254\270\354\204\234-\354\236\221\354\227\205.md" new file mode 100644 index 00000000..4082bd7d --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\353\254\270\354\204\234-\354\236\221\354\227\205.md" @@ -0,0 +1,30 @@ +--- +name: 문서 작업 +about: '문서 작성 및 수정' +title: "[DOCS] " +labels: "📜 DOCS" +assignees: '' + +--- + +## 📜 작성/수정할 문서 + +
+ +## 📝 작업 내용 +- [ ] +- [ ] +- [ ] + +
+ +## 💡 문서 종류 (해당하는 것에 체크) +- [ ] README +- [ ] API 명세서 +- [ ] 아키텍처 문서 +- [ ] 개발 가이드 +- [ ] 배포 가이드 +- [ ] 코드 주석 +- [ ] 기타 + +
\ No newline at end of file diff --git "a/.github/ISSUE_TEMPLATE/\353\260\260\355\217\254-\352\264\200\353\240\250.md" "b/.github/ISSUE_TEMPLATE/\353\260\260\355\217\254-\352\264\200\353\240\250.md" new file mode 100644 index 00000000..a8902705 --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\353\260\260\355\217\254-\352\264\200\353\240\250.md" @@ -0,0 +1,39 @@ +--- +name: 배포 관련 +about: '인프라 및 배포 관련 작업' +title: "[DEPLOY] " +labels: "🚀 DEPLOY, 🌐 infra" +assignees: '' + +--- + +## 🚀 배포 작업 내용 + +
+ +## 🏗️ 작업 종류 (해당하는 것에 체크) +- [ ] AWS 인프라 변경 +- [ ] Docker 설정 변경 +- [ ] CI/CD 파이프라인 수정 +- [ ] Nginx 설정 변경 +- [ ] 환경 변수 변경 +- [ ] 데이터베이스 마이그레이션 +- [ ] 기타 + +
+ +## 📋 작업 상세 설명 + +
+ +## ⚠️ 주의사항 + + +
+ +## ✅ 체크리스트 +- [ ] 개발 환경 테스트 완료 +- [ ] 배포 계획 수립 +- [ ] 팀원 공유 완료 + +
\ No newline at end of file diff --git "a/.github/ISSUE_TEMPLATE/\353\262\204\352\267\270-\354\210\230\354\240\225.md" "b/.github/ISSUE_TEMPLATE/\353\262\204\352\267\270-\354\210\230\354\240\225.md" new file mode 100644 index 00000000..ca9f6198 --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\353\262\204\352\267\270-\354\210\230\354\240\225.md" @@ -0,0 +1,37 @@ +--- +name: 버그 수정 +about: '버그 및 오류 수정' +title: "[FIX] " +labels: "🔧 FIX" +assignees: '' + +--- + +## 🐛 버그 내용 + + +
+ +## 🏷️ 도메인 (해당하는 것에 체크) +- [ ] 📝 domain:post (게시글) +- [ ] 👤 domain:user (사용자) +- [ ] 🏢 domain:source (테크블로그 출처) +- [ ] 🔍 domain:search (검색) +- [ ] 🔔 domain:notification (알림) +- [ ] 📊 domain:recommendation (추천) +- [ ] 🌐 infra (인프라/배포) + +
+ +## ⚠️ 에러 로그 / 스크린샷 + +``` +에러 로그를 여기에 붙여넣기 +``` + +
+ +## 🎯 예상 원인 + + +
\ No newline at end of file diff --git "a/.github/ISSUE_TEMPLATE/\354\230\244\353\245\230\354\210\230\354\240\225.md" "b/.github/ISSUE_TEMPLATE/\354\230\244\353\245\230\354\210\230\354\240\225.md" deleted file mode 100644 index 4c104029..00000000 --- "a/.github/ISSUE_TEMPLATE/\354\230\244\353\245\230\354\210\230\354\240\225.md" +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: 오류수정 -about: '오류 설명 및 수정 ' -title: "[DEBUG]" -labels: "\U0001F577️ BUG" -assignees: '' - ---- - -## 오류 내용 - -
- - -## ⚠ 에러로그 캡쳐 - -
diff --git a/docs/commit-convention.md b/docs/commit-convention.md new file mode 100644 index 00000000..0516ba8e --- /dev/null +++ b/docs/commit-convention.md @@ -0,0 +1,23 @@ +### Format +``` +: +``` + +### Types +- **feat**: 새로운 기능 추가 +- **improve**: 기존 기능 개선/변경 +- **refactor**: 기능 변경 없는 코드 리팩토링 +- **fix**: 버그 수정 +- **chore**: 기타 수정 (설정, 의존성 등) +- **docs**: 문서 작업 +- **deploy**: 배포/인프라 관련 + +### Examples +```bash +feat: 게시글 댓글 기능 구현 +improve: 게시글 검색에 카테고리 필터 추가 +refactor: 예외 처리 로직 메서드 분리 +fix: 로그인 후 리다이렉트 오류 해결 +chore: Gradle 의존성 버전 업데이트 +docs: API 명세서 업데이트 +deploy: EC2 인스턴스 타입 변경 \ No newline at end of file diff --git a/docs/pr-convention.md b/docs/pr-convention.md new file mode 100644 index 00000000..fe398adb --- /dev/null +++ b/docs/pr-convention.md @@ -0,0 +1,26 @@ +### 형식 +``` +[타입/#이슈번호] 작업 내용 +``` + +### 예시 +```bash +[feat/#23] 게시글 스크랩 기능 구현 +[fix/#17] RDS 접근을 public access 대신 ec2에서 접속하도록 변경 +[improve/#45] 게시글 검색에 카테고리 필터 추가 +[refactor/#40] GlobalExceptionHandler 중복 코드 제거 +[debug/#11] 헬스 체크 경로에 누락된 헤더 정보 추가 +[chore/#60] Spring Boot 3.5.7로 업데이트 +[docs/#70] README API 문서 링크 추가 +[deploy/#80] RDS 스토리지 타입 gp3→gp2 변경 +``` + +### 타입 +- **feat**: 새로운 기능 추가 +- **improve**: 기존 기능 개선/변경 +- **refactor**: 기능 변경 없는 코드 리팩토링 +- **fix**: 버그 수정 +- **debug**: 디버깅 및 오류 해결 +- **chore**: 기타 수정 (설정, 의존성 등) +- **docs**: 문서 작업 +- **deploy**: 배포/인프라 관련 \ No newline at end of file