[Git] 커밋 메시지 규칙

Git 커밋 메시지 7가지 규칙

1. 제목과 본문을 빈 행으로 구분
2. 제목은 50글자 이내로 제한
3. 제목의 첫 글자는 대문자로 작성(한글은 상관 X)
4. 제목 끝에는 마침표를 넣지 않음
5. 제목은 명령문으로 사용하며(한글은 상관 X) 과거형을 사용하지 않음
6. 본문의 각 행은 72글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명

커밋 메시지 구조

// Header
타입(스코프): 주제

// Body
본문

// Footer
참조

 

Header, Body, Footer는 줄바꿈으로 구별

Header는 필수(스코프는 생략 가능)

 

타입 종류

타입 이름	내용
feat	새로운 기능에 대한 커밋
fix	버그 수정에 대한 커밋
build	빌드 관련 파일 수정 / 모듈 설치 또는 삭제에 대한 커밋
chore	그 외 자잘한 수정에 대한 커밋
ci	ci 관련 설정 수정에 대한 커밋
docs	문서 수정에 대한 커밋
style	코드 스타일 혹은 포맷 등에 관한 커밋
refactor	코드 리팩토링에 대한 커밋
test	테스트 코드 수정에 대한 커밋
perf	성능 개선에 대한 커밋

 

Body는 Header에서 표한할 수 없는 상세한 내용 적기

Header에서 충분히 표현 가능하다면 생략 가능

 

Footer는 어떤 이슈에서 왔는지 등 참조 정보들을 추가하는 용도로 사용

Footer 생략 가능

 

작성 예시

*파일명: CustomDivide.txt

feat: 문자열의 숫자를 구분자로 나누는 인터페이스의 구현체2: 커스텀 구분자 사용

커스텀 구분자로 숫자들을 분리하여 문자열 배열에 추가
이후 문자열 배열을 숫자 배열로 변경하여 Input 인터페이스의 구현체로 리턴

resolves: #10

 

*콘솔 명령어

git commit -F CustomDivide.txt

 

 

출처: https://velog.io/@chojs28/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EA%B7%9C%EC%B9%99

Git 커밋 메시지 규칙