Skip to content

PR 컨벤션

MinJun Choi edited this page Jul 12, 2026 · 1 revision

🔀 PR 컨벤션

PR 제목은 [태그] 내용 형식이 CI로 강제됩니다. 머지 조건과 릴리스 규칙을 정리합니다.


🔖 제목 형식 (CI로 강제)

[태그] 내용
  • 태그 : 소문자 feat fix chore doc refactor 중 하나
  • 태그 뒤 공백 1개 + 내용 5자 이상
  • 위반 시 Validate PR Title 체크 실패 → 머지 차단

✅ / ❌ 예시

[feat] 소셜 로그인 API 구현      ✅
[fix] 토큰 재발급 오류 수정       ✅
feat: 로그인 추가                ❌ 대괄호 없음
[Feat] 로그인                    ❌ 대문자 태그
[hotfix] 급한 수정                ❌ 허용 안 된 태그
[fix] 수정                       ❌ 내용 5자 미만

📄 PR 템플릿

PR 생성 시 자동으로 채워지는 항목:

  • 🔗 연관 이슈close #번호
  • 📌 개요 — 무엇을 / 왜
  • 🔧 주요 변경사항
  • 🌐 API · DB 영향 — API 변경 / DB 마이그레이션 / 하위 호환
  • 💬 리뷰 포인트

✅ 리뷰 · 머지 조건

PR을 머지하려면 모두 충족해야 합니다:

  • build 통과 (빌드 · 테스트 · ktlint)
  • Validate PR Title 통과
  • ✅ 승인 1명 이상
  • ✅ 머지 방식 — dev = Squash / prod = Merge commit

💡 CodeRabbit이 PR마다 자동 코드 리뷰 코멘트를 남깁니다.


🏷️ 릴리스 (dev → prod)

dev → prod PR을 머지하면 vX.Y.Z 태그와 릴리스가 자동 생성됩니다. 버전 증가 단계는 PR 제목 키워드로 지정:

제목 키워드 버전 예시 (v0.2.1 기준)
(없음) patch [chore] 정기 배포v0.2.2
#minor minor [feat] 채팅 출시 #minorv0.3.0
#major major [chore] 정식 출시 #majorv1.0.0
  • 릴리스 노트는 머지된 PR 목록으로 자동 생성됩니다
  • 키워드가 없으면 기본 patch(Z+1)

🔗 관련 문서

Clone this wiki locally