Commit Convention

커밋 메시지 기본 구조

<type>: <description>
[optional body]


[optional footer(s)]

<타입>: <설명>

[본문 (선택 사항)]

[꼬리말 (선택 사항)]

예시

feat: 회원가입 기능 추가

회원가입 API 개발
이메일 중복 확인 추가

커밋 메시지 컨벤션

커밋 유형 지정 (영어 대문자로 작성)

커밋 유형	설명
feat	새로운 기능 추가
init	프로젝트 초기 설정, 신규 파일 생성
fix	버그 수정
docs	문서 수정
refactor	코드 리팩토링 (기능 변경 없음)
update	기능 수정 (정책 변경 등)
test	테스트 코드 추가
move	파일 이동 및 정리
build	빌드 관련 변경, 의존성 추가/삭제
comment	주석 추가 및 변경
del	기능/파일 삭제

커밋 메시지 작성 규칙

제목과 본문을 빈 줄로 분리

feat: 회원가입 기능 추가

회원가입 API 개발
이메일 중복 확인 추가

제목은 소문자로 작성, 끝에는 . 금지
❌ Feat: 회원가입 기능 추가. (X)
✅ feat: 회원가입 기능 추가 (O)

제목은 50자 이내
❌ feat: 회원가입 API 개발을 진행하면서 이메일 중복 확인 기능까지 추가 및 기타 수정 사항 반영 (X)
✅ feat: 회원가입 API 개발 및 이메일 중복 확인 추가 (O)

본문에는 변경 사항과 이유 설명 (어떻게보다는 "무엇 & 왜"를 설명)

fix: 회원가입 오류 수정

비밀번호 검증 로직 수정
유효성 검사 강화

여러 개 항목이 있을 경우 리스트(-) 사용

refactor: 회원가입 서비스 리팩토링

서비스 로직 분리
예외 처리 추가
기존 코드 리팩토링

타입 뒤에는 반드시 : (콜론+공백) 필요 ❌ feat 회원가입 기능 추가 (X)
✅ feat: 회원가입 기능 추가 (O)

좋은 커밋 메시지를 작성해야 하는 이유

• 팀원과의 원활한 소통
• 편리하게 과거 기록 추적 가능
• 실무에서 익숙해지기 위해 필수

한 커밋에는 한 가지 문제만 해결할 것!

• 여러 개의 문제를 한 커밋에 담으면 추적하기 어려움.
• 작은 단위로 커밋하면 나중에 되돌리기 쉬움.

CLI에서 여러 줄 커밋 메시지 작성하는 방법

쌍따옴표(")를 닫지 않고 개행 후 마지막에 닫기

git commit -m "feat: 회원가입 기능 추가

회원가입 API 개발
이메일 중복 확인 추가"

꼬리말 (Footer) 사용하기

• 관련 이슈 번호나 브레이킹 체인지 등을 설명할 때 사용

BREAKING CHANGE: 모든 인증 요청에 JWT 토큰이 필요합니다.
이전 버전의 세션 기반 인증은 더 이상 동작하지 않습니다.
Resolved: #123

커밋 메시지 템플릿 적용하기

.gitmessage.txt 생성

# <타입>: <변경 요약>


/*
예: feat: 기존 인증 방식 제거
<본문 - 상세 설명>
무엇을 변경했는지 설명합니다.
예: 다크 모드를 활성화할 수 있는 토글 버튼을 추가했습니다.
변경한 이유나 배경을 설명합니다.
예: 사용자가 저조도 환경에서도 편리하게 사용할 수 있도록
다크 모드 기능을 추가하였습니다.

UI 설정에서 라이트와 다크 테마를 전환할 수 있습니다.
다크 테마는 기본적으로 환경 설정에 맞춰 자동 전환됩니다.

<푸터 - 관련 정보>
예: Resolved #123
------------- 참고 -------------



타입
설명




✨ feat
새로운 기능 추가


🎉 init
프로젝트 초기 설정, 신규 파일 생성


🩹 fix
버그 수정


📝 docs
문서 수정


♻️ refactor
기능 변경 없이 코드 개선


🔧 update
정책 변경 등 기능 수정


💻 build
빌드 관련 변경, 의존성 추가/삭제


🌱 comment
주석 추가 및 변경


🚚 move
파일 이동 및 정리


🔥 del
기능/파일 삭제


🍻 test
테스트 코드 추가



<변경 요약(제목)>

커밋 타입 뒤에는 반드시 : (콜론+공백)을 추가합니다.
변경 사항을 50자 이내로 간결하게 작성합니다.
문장 끝에 마침표(.)를 사용하지 않습니다.
예: feat: 다크 모드 추가 / fix(auth): 로그인 오류 수정


<본문>

제목과 본문 사이에 빈 줄을 추가합니다.
무엇을, 왜 변경했는지 설명합니다.
각 줄은 72자 이내로 유지하며, 세부 사항은 "-" 기호로 구분합니다.

<푸터>

본문과 푸터 사이에 한 줄을 띄웁니다.
관련 이슈 번호를 명시합니다. (예: Resolved #123)
브레이킹 체인지가 있을 경우 명시합니다.
*/

Git 설정에서 템플릿 적용

git config --global commit.template ~/.gitmessage.txt

• 전역 적용 (--global) → 모든 프로젝트에서 사용
• 특정 프로젝트에만 적용하려면 --global 생략 후 프로젝트 디렉토리에서 실행

커밋 메시지 작성 시 자동 적용

git commit

• git commit 실행 시 템플릿이 자동으로 표시됨