양식
{타입}({적용 범위}): {설명} {본문} {꼬리말}
- 각 부분 사이 뉴라인으로 구분
- 본문, 꼬리말은 생략 가능하지만 본문은 웬만하면 쓰자
제목
- 타입
feat:
- 기능 추가
fix:
- 버그 수정
design:
- UI 디자인 변경
BREAKING CHANGE:
또는{type}!:
또는!{type}:
- 강조할 만한 변경 사항
remove:
- 파일 삭제
docs:
- 문서 수정
style:
- 코드 자체에는 수정 없는 요소들(세미콜론, 공백, 포맷 변경 등)
refactor:
- 리팩토링
test:
- 테스트 코드 추가/수정
chore:
- 빌드 또는 패키지 매니저 수정 사항
- iOS의
Info.plist
, 안드의build.gradle
같은 거인 듯
- 동사 원형으로 시작, 50자 이내로 간략히
- 첫 글자는 대문자, 명령문 및 동사 원형 사용, 마침표 x
- 적용 범위
- Ex)
feat(database):
- 생략 가능
본문
- 최대한 자세하게, 한 줄이 너무 길지 않게 끊어서
어떻게
보다는무엇
을왜
변경하였는가
- 기존의 문제 등 context에 대한 간략한 설명
- 내용이 많은 경우 bullet point 가능
- Some... - And...
꼬리말
- Optional. 이슈 id 명시하고 싶을 때 등에 추가
Fixes:
- 이슈 수정중
Resolves:
- 이슈를 해결했을 때
Ref:
- 참고할 이슈
Related to:
- 해당 커밋에 관련된 이슈번호