type: subject
(한 줄을 띄워 분리.)
body
(한 줄을 띄워 분리.)
footer
"태그: 제목"의 형태이며, : 뒤에만 space가 있음
feat |
새로운 기능을 추가할 경우 |
|---|---|
fix |
버그를 고친 경우 |
docs |
문서 수정 |
style |
코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우 |
refactor |
코드 리펙토링 |
test |
테스트 코드, 리펙토링 테스트 코드 추가 |
chore |
빌드 업무 수정, 패키지 매니저 수정 |
comment |
주석 추가 및 수정 |
remove |
파일을 삭제하는 작업만 수행한 경우 |
rename |
파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우 |
제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않는다.
영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기한다.(과거 시제를 사용하지 않는다.)
제목은 개조식 구문으로 작성한다. --> 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미.
영어로 작성하는 경우
아래와 같은 동사원형을 가장 앞에 작성
# Add : 추가
# Remove : 삭제
# Simplify : 단순화
# Update : 보완
# Implement : 구현
# Prevent : 방지
# Move : 이동
# Rename : 이름 변경
⇒ ex. fix: Update Login Logic
한글로 작성하는 경우
"고침", "추가", "변경"의 명령어로 시작
⇒ ex. feat: 추가 get data api 함수
본문은 한 줄 당 72자 내로 작성한다.
본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.