제목,본문,꼬리말 세가지 파트로 나누고, 각 파트는 빈줄을 두어 구분
type : subject
body
footer
type : 어떤 의도로 커밋했는지 명시subject : 최대 50글자를 넘지 않도록 하고 마침표는 찍지 않음. 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기body : 긴 설명이 필요한 경우 작성, 무엇을 왜 했는지를 중점으로 작성footer : issue tracker ID를 명시하고 싶은 경우에 작성| 타입 | 설명 |
|---|---|
feat | 새로운 기능 추가 |
fix | 버그 수정 |
docs | 문서 수정 (README 등) |
style | 코드 스타일 수정 (포매팅, 세미콜론 등) |
refactor | 코드 리팩토링 (기능 변경 없이 구조 개선) |
perf | 성능 향상 관련 변경 |
test | 테스트 코드 추가/수정 |
chore | 빌드/패키지 매니저 설정 등 기타 변경 |
ci | CI 관련 설정 변경 |
build | 빌드 관련 파일 수정 |
revert | 이전 커밋 되돌리기 |
* Fixed --> Fix
* Added --> Add
* Modified --> Modify
본문은 한 줄 당 72자 내로 작성
본문 내용은 제목과 달리 양에 구애받지 않고 최대한 상세히 작성
어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성
꼬리말은 선택사항이고, 이슈 트래커 ID를 작성
꼬리말 형식 : 유형 : # 이슈 번호
여러 개의 이슈 번호를 적을 때는 쉼표로 구분
| 이슈 트래커 유형 | 설명 |
|---|---|
| Fixes | issue 수정중( 아직 해결 안됨 ) |
| Resolves | issue 해결 완료 |
| Ref | 참고할 issue 존재 시 |
| Related to | 해당 커밋에 관련된 이슈 번호( 아직 해결 안됨 ) |
ex) Fixes: #45 Related to: #34, #23
Feat : 추가 조회 메소드 추가
로그인 API 개발
Resolves: #123
Ref: #456
Related to : #100