제목, 본문, 꼬리말 세가지 파트로 나누고, 각 파트는 빈줄을 두어 구분해요.
type : subject
body
footer
type은 태그와 제목으로 구성되고, 태그는 영어로 쓰되 첫 문자는 대문자로 해요.
| 태그 | 제목 |
|---|---|
| Feat | 새로운 기능 추가 |
| Fix | 버그 수정 |
| Docs | 문서 수정 |
| Style | 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우 |
| Refactor | 코드 리펙토링 |
| Test | 테스트(테스트 코드 추가, 수정, 삭제, 비즈니스 로직에 변경이 없는 경우) |
| Chore | 위에 걸리지 않는 기타 변경사항 (빌드 스크립트 수정, assets image, 패키지 매니저 등) |
| Design | CSS 등 사용자 UI 디자인 변경 |
| Comment | 필요한 주석 추가 및 변경 |
| Init | 프로젝트 초기 생성 |
| Rename | 파일 혹은 폴더명 수정하거나 옮기는 경우 |
| Remove | 파일을 삭제하는 작업만 수행하는 경우 |
- 제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않아요.
- 영문 사용 시, 동사원형 사용하고, 첫 글자는 대문자로 표기해요. 과거 시제를 사용하지 않아요.
- 제목은 개조식 구문으로 작성해요. (완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미)
- 본문은 한 줄 당 72자 내로 작성해요.
- 본문 내용은 양에 구애받지 않고 최대한 상세히 작성해요.
- 본문 내용은 어떻게 변경했는지 보다 '무엇을', '왜' 변경했는지를 설명해요.
꼬리말은 선택 사항이고 이슈 트래커 ID를 작성해요.
꼬리말은 "유형: #이슈 번호" 형식으로 사용해요. 여러 개의 이슈 번호를 적을 때는 쉼표(,)로 구분해요.
이슈 트래커 유형은 다음 중 하나를 사용해요.
| 유형 | 설명 |
|---|---|
| Fixes | 이슈 수정중 (아직 해결되지 않은 경우) |
| Resolves | 이슈를 해결했을 때 사용 |
| Ref | 참고할 이슈가 있을 때 사용 |
| Related to | 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우) |
예제는 다음과 같아요.
Fixes: #45
Related to: #34, #23
Feat: Add signin, signup
회원가입 기능, 로그인 기능 추가(예시를 위해 간단히 작성)
Resolves: #1