git commit message
를 작성하는데, 매번 다르게 작성을 하다보니 통일화된 규칙이 없을까 하면서 찾아보았습니다.
- 제목과 본문을 한 줄 띄어 분리합니다.
- 제목은 영문 기준 50자 이내로 작성합니다.
- 제목 첫 글자는 대문자로 작성합니다.
- 제목 끝에 마침표를 넣지 않습니다.
- 제목은 명령문으로 사용하며 과거형을 사용하지 않습니다.
- 본문의 각 행은 72글자 내로 제한합니다.
- 본문은 how보다 what, why에 맞춰 작성합니다.
<type>(<scope>): <subject> <body> <footer>
Header
: 필수Body
: 필수Footer
: 선택
- feat :
new feature
추가, 기존의feature
를requirement
에 맞춰 수정- fix :
feature
에 대한bug
수정- docs :
document(commnet)
수정- comment : 필요한
comment
추가 및 변경- style :
code formatting
,세미콜론(;)
누락, 코드 변경이 없는 경우- refactor :
code refactoring
- test :
test code
,refactoring test code
추가(production code
변경 X)- chore :
build
업무 수정,package
매니저 수정(프로덕션 코드 변경 X)- design :
CSS
등 사용자UI design
변경- rename :
file
혹은folder name
을 수정하거나 옮기는 작업만인 경우- remove :
file
을 삭제하는 작업만 수행한 경우- !BREAKING CHANGE : 커다란
API
변경한 경우- !HOTFIX : 급하게 치명적인
BUG
를 고쳐야 하는 경우
감사합니다.