COMMIT_CONVENTION.md

📝 커밋 메시지 컨벤션

일관된 커밋 메시지 작성을 위해 아래와 같은 컨벤션을 따른다.

📌 커밋 메시지 Description(본문)에 적는 내용

• 무엇을 왜 변경했는지, 왜 만들었는지 구체적으로 설명한다.
• 어떻게 변경했는지 간략하게 기술한다.
• 중요한 참고사항 (예: 성능 개선 방법, 영향 범위, 주의할 점)
• 관련 이슈 번호나 링크가 있다면 적어서 제출한다.
• 만약 큰 변경이면 변경된 구조나 흐름 설명한다.

🔧 커밋 타입 목록

타입	설명
[FEAT]	새로운 기능 추가
[FIX]	버그 수정
[DOCS]	문서 변경 (README, API 명세 등)
[STYLE]	코드 포맷팅 (세미콜론, 줄바꿈, 공백 등)
[REFACTOR]	코드 리팩토링 (기능 변화 없음, 성능 개선/가독성 개선 등)
[CHORE]	빌드 설정, 패키지 매니저 설정, 기타 변경사항 (코드 변경 없음)
[CI]	CI 관련 설정 수정 (GitHub Actions)
[SECURITY]	보안 관련 설정

🔍 예시 커밋 메시지

✨ FEAT : 이메일 인증 API 추가
🐛 FIX : 로그인 실패 시 예외 메시지 수정
📝 DOCS : Swagger UI 주소 문서에 명시
🎨 STYLE : 코드 포맷 prettier 적용
♻️ REFACTOR : 중복된 유효성 검사 메서드 리팩토링
🔧 CHORE : .gitignore에 log 디렉토리 추가
⚙️ CI : GitHub Actions 환경 변수 설정 추가

🛑 커밋 메시지 작성 시 주의사항

• 한글 또는 영어 둘 다 가능하지만, 통일성 있게 작성
• 명령형 사용 → ~했다 ❌ / ~한다, 추가, 수정 등으로 ✅
• 커밋의 목적과 의미를 간결하게 전달

🚀 시행 시점

API 명세서 작성 후 부터 바로 시행