목차
Commit message 규칙
Commit message 구조
Type 종류
git에서 쓰이는 commit message 작성 규칙에 대해 알아보겠습니다.
Commit message 규칙
- 제목과 본문을 한 줄 띄어 구분
- 제목은 50자 이내
- 제목 첫 글자는 대문자
- 제목 끝에 마침표를 붙이지 말 것
- 제목은 명령문으로 쓸 것 (과거형 X)
- 본문의 각 행은 72자 이내
- 본문은 어떻게 보다 무엇을, 왜에 대하여 설명
Commit message 구조
<type>: <subject>
<body>
<footer>
예시
feat: Add sort api
type 종류
- feat : 새로운 기능 추가 및 기존 기능 수정
- fix : 기능에 대한 버그
- build : 빌드 관련
- chore : 패키지 매니저 등
- ci : CI 관련 설정
- docs : 문서(주석)
- style : 코드 스타일 및 포맷팅
- refactor : 리팩터링
- test : 테스트 코드
- release : 버전 릴리즈
출처
- jiheon. (2021). [Git] Commit message 규칙. https://velog.io/@jiheon/Git-Commit-message-규칙