GitHub | 커밋 메시지 작성

GitHub 커밋 메시지는 왜 남길까?

코드의 가독성을 높이고, 협업을 원활하게 만드는 중요한 습관이라고 한다. (Chat GPT)

 

커밋 메시지의 기본 구조

 

제목(Type: Subject)

{공백}

본문(Body) - 필요한 경우

{공백}

꼬리말(Footer) - 필요한 경우

 

예시▼

feat: 사용자 로그인 기능 추가

 

~기능을 구현했습니다.

 

 

커밋 메시지 타입

feat	새로운 기능 추가
fix	버그 수정
refactor	기능 변경 없이 코드 개선
style	코드 스타일 변경(포맷팅, 세미콜론 추가 등)
docs	문서(README.md 등) 수정
test	테스트 코드 추가 및 수정
chore	빌드, 패키지 매니저 설정 등 기타 변경
perf	성능 개선
build	프로젝트의 빌드 프로세스 관련(빌드 시스템, 의존성 관리, 배포 설정)
BREAKING CHANGE	기존 코드와 호환되지 않는 중요한 변경 사항 *본문에서 작성 ex) feat: JWT 기반 인증 시스템 변경 기존의 세션 기반 인증 방식을 제거하고 JWT 인증 방식으로 변경하였습니다. BREAKING CHANGE: 기존 로그인 API (`POST /auth/login`) 응답 형식이 변경되었습니다. 이제 클라이언트는 쿠키가 아니라 `Authorization` 헤더를 통해 JWT를 전달해야 합니다.

 

 

제목과 본문 작성 시 유의 사항

 

제목은 한 줄*로 간결하게

명령문 사용(Added 대신 Add 사용)

문장 끝에 마침표 사용하지 않기

본문이 있다면, '무엇'을 '왜' 변경했는지 설명

관련 이슈 번호가 있다면 포함

 

*한 줄 요약이 어려운 경우, 본문 추가(제목과 본문 사이에 빈 줄 넣기)

 

Conventional Commits 1.0.0

 

 

커밋 메시지 자동화 도구_Commitizen

협업이 많다면 Husky 설치 후 pre-commit 훅 설정(규칙을 따르지 않은 커밋 메시지는 커밋이 막히게 됨)