Team Git Commit Convention (Conventional Commits)
본 문서는 팀 전체가 일관된 커밋 메시지를 작성하기 위해 Conventional Commits v1.0.0 규칙을 기반으로 정의한 Git Commit Convention입니다.
- 기준 명세: Conventional Commits v1.0.0
- 목적: 변경 이력의 가독성 향상, 리뷰 효율화, 자동 릴리스/체인지로그/버전 관리 지원
1. 기본 원칙
- 모든 커밋 메시지는 Conventional Commits 포맷을 따른다.
- 커밋 제목(Subject)은 명령형(Imperative) 으로 작성한다. (예:
add, fix, update)
- 제목은 간결하게 작성한다. (권장: 72자 이내)
- 한 커밋은 하나의 논리적 변경을 담는다. (가능하면)
- Break changes(호환성 파괴)는 반드시 Breaking Change 표기를 한다.
2. 커밋 메시지 포맷
2.1 표준 포맷
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
- type: 변경 성격(필수)
- scope: 변경 범위(선택) — 모듈/패키지/기능 영역 등
- description: 변경 요약(필수)
- body: 변경 이유/맥락/세부 사항(선택)
- footer: 이슈 링크, Breaking Change, 메타 정보(선택)