1️⃣ 커밋 메시지 컨벤션

<type>(<scope>): <subject>

<aside> ✅

1. 커밋 유형(type) 작성 규칙

• 커밋 유형은 영어 대문자로 작성하기

  커밋 유형	의미
  Feat	새로운 기능 추가
  Fix	버그 수정
  Docs	문서 작업
  Style	코드 formatting, 세미콜론 누락, 코드 자체의 변경이 없는 경우
  Refactor	코드 리팩토링
  Test	테스트 코드, 리팩토링 테스트 코드 추가
  Chore	패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore
  Comment	필요한 주석 추가 및 변경
  Rename	파일 또는 폴더 명을 수정하거나 옮기는 작업만인 경우
  Remove	파일을 삭제하는 작업만 수행한 경우
  !BREAKING CHANGE	커다란 API 변경의 경우
  !HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우

2. <Scope> 작성 규칙

• 에픽 단위로 키워드 단어 설정

  Scope 유형	의미
  BackOffice	백오피스
  Auth	인증/인가
  Main	메인 대시보드

• 더 필요하다면 이해 가능한 키워드 자율적으로 추가

  • auth, user, admin, notice, order, config, db, ci

3. <Subject> 작성 규칙

• 한국어/영어 혼용 가능(팀 합의 우선)
• 현재형
• 마침표 금지
• 50자 내
• 예시

4. 작성 예시

• feat(admin): 관리자 로그인 API 추가
• fix(order): 주문 조회 시 NPE 수정
• chore(db): flyway V3 마이그레이션 추가

5. 커밋 단위 규칙

• 커밋 1개는 “설명 가능한 단일 변경” 단위.
• Flyway 마이그레이션은 별도 커밋으로 분리 권장(충돌 추적 쉬움). </aside>

2️⃣ 브랜치 컨벤션

<aside>

1. 브랜치 종류

• main - 최종 배포용 브랜치
  • dev - 개발 브랜치
    • feat/* - 기능 개발 브랜치
    • fix/* - 수정 브랜치

2. 브랜치 네이밍 규칙

• 브랜치명은 소문자 + 하이픈.

• 단수 사용으로 통일

• 형식

  • feat/{backlogId}-{short-desc}
  • fix/{backlogId}-{short-desc}
  • 예시:
    • feat/12-admin-login
    • feat/21-notice-crud
    • fix/33-null-pointer
    • chore/05-add-flyway
    • 동일 백로그를 여러 명이 작업하는 경우
      • feat/225-swagger-docs-data
        • 하위 브랜치 목록
        • {작업형태}/{backlogId}-{short-desc}-{(Optional) first name}
        • feat/225-swagger-family-junha
        • feat/225-swagger-policy-misu

• backlogId: Jira 백로그 식별자

  

  • ex) ry1-999 → 999(공통 접두사 ‘ry1’ 제거)
    • feat/999-create-project </aside>

3️⃣ PR 컨벤션

rule

• 리뷰어 설정(최소 1명)
• 담당자 설정(PR 발행자)
• main 으로의 merge는 dev 브랜치에서만 가능
• 사용 다한 브랜치는 원격 저장소에서 삭제 (여유롭게 천천히)

제목 양식

[backlogId] 제목

• ex) [999] 프로젝트 개발

본문 양식

## 개요
<!---- 변경 사항 및 관련 백로그 대해 간단하게 작성해주세요. 어떻게보다 무엇을 왜 수정했는지 설명해주세요. -->

## 관련 백로그
<!---- 해당 PR과 관련된 백로그 번호가 있다면 작성해주세요. -->
Resolves: (Backlog Number, ...)

## PR 유형
<!-- 어떤 변경 사항이 있나요? -->

- [x] 새로운 기능 추가
- [ ] 버그 수정
- [ ] CSS 등 사용자 UI 디자인 변경
- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
- [ ] 코드 리팩토링
- [ ] 주석 추가 및 수정
- [ ] 문서 수정
- [ ] 테스트 추가, 테스트 리팩토링
- [ ] 빌드 부분 혹은 패키지 매니저 수정
- [ ] 파일 혹은 폴더명 수정
- [ ] 파일 혹은 폴더 삭제

## PR Checklist
<!-- PR이 다음 요구 사항을 충족하는지 확인하세요. -->

- [x] 커밋 메시지 컨벤션에 맞게 작성했습니다.
- [x] 변경 사항에 대한 테스트를 했습니다.(버그 수정/기능에 대한 테스트).