GIT 커밋메시지 컨벤션(규칙)

팀원들과 협업을 하기 위해서는 규칙을 잘 정해 잘 지켜나가는 것이 중요하다고 생각합니다. 

오늘은 GIT 커밋 시 입력하는 커밋메시지 작성 규칙에 대해 포스팅하겠습니다. 

 

COMMIT MESSAGE 규칙

 

1. 제목과 본문 사이 한 줄 띄어쓰기
2. 제목은 50자 이내로 쓰기 
3. 제목 첫 글자는 대문자 
4. 제목 끝에 마침표 쓰지 않기 
5. 제목은 명령문, 현재형으로 작성하기 
6. 본문의 각 행은 72자 이내 
7. 본문은 '어떻게' < '무엇'을, '왜'에 초점을 맞추어 작성

 

TYPE + HEADER

예시) 

fix: 게시판 글 조회 오류 수정 
- BoardController 글 조회 메소드 userService > boardService로 변경

header 앞에 붙여 쓰며 어떤 형식의 변경이 이루어졌는지 표현할 수 있습니다. 

• feat 새로운 기능 추가, 기존의 기능을 수정 
• fix 기능에 대한 버그 수정
• build 빌드 관련 수정
• chore 패키지 매니저 수정 (pom.xml, .gitignore 등)
• ci CI 관련 설정 수정
• docs 문서, 주석 수정 
• style 코드 스타일, formatting 수정
• refactor 기능 변화가 아닌 코드 리팩터링 
• test 테스트 코드 추가 
• release 버전 릴리즈 

 

하단 블로그를 참조하면 커밋 메시지 템플릿을 적용해 빠르고 정확하게 커밋 메시지를 작성할 수 있습니다. 

https://kdjun97.github.io/git-github/commit-convention/

[Git/Github] Commit Convention이란?