1. 메세지 구조
commit 메세지는 제목, 본문, 꼬리말로 나뉘고, 각 파트는 줄바꿈으로 구분합니다.
type: Subject -> 제목
body -> 본문
footer -> 꼬리말- type
어떤 의도로 커밋했는지를 type에 명시합니다. - subject
최대 50글자가 넘지 않도록 하고 마침표는 찍지 않습니다.
-
body
긴 설명이 필요한 경우에 작성합니다.
어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성합니다.
최대 75자를 넘기지 않도록 합니다. -
footer
issue tracker ID를 명시하고 싶은 경우에 작성합니다.
2. 제목
타입
-
타입은 태그와 제목으로 구성됩니다.
-
관례적으로 사용하는 태그
태그 이름 설명 기능 ------------------------------------------------ feat 새로운 기능 추가 fix 버그 픽스 개선 ------------------------------------------------ style 코드 포맷 변경 / 세미 콜론 누락 / 코드 수정이 없는 경우
오타 수정, 탭 사이즈 변경, 변수명 변경 등refactor 코드 리팩토링
새로운 기능이나 버그 수정 없이 현재 구현을 개선한 경우comment 주석 추가 / 수정 그 외 ------------------------------------------------ docs 문서 수정
ex) README.md 수정test 테스트 코드 작성 chore 프로덕선 코드 수정 없이 빌드 설정 등 업데이트
ex) .gitignore, application.yml 수정rename 파일 / 폴더명을 수정하거나 옮기는 작업 remove 파일 삭제
주제
무슨 작업을 했는지 간단하게 적습니다.
예시 (타입 + 주제)
Feat: 회원가입 기능 구현
Fix: 비밀번호 확인 로직 버그 수정
3. 본문
- 한 줄당 72자 내로 작성합니다.
- 양에 구애받지 않고 최대한 상세히 작성합니다.
- 어떻게 변경했는지보다 무엇을 변경했는지, 왜 변경했는지를 작성합니다.
4. 꼬리말
-
꼬리말은 선택적으로 작성하고, 이슈 트래커 ID를 작성합니다.
-
"유형: #이슈 번호"형식으로 사용합니다. -
유형은 다음 중 하나를 사용합니다.
유형 이름 설명 Fixes 이슈 수정 중 (아직 해결되지 않았을 때 사용) Resolves 이슈를 해결했을 때 사용 Ref 참고할 이슈가 있을 때 사용 Related to 커밋에 관련된 이슈 번호 -
작성 예시
Fixes: #45 Related to: #34, #23
5. 최종 예시
- 제목, 본문, 꼬리말을 합치면 다음과 같은 양식이 만들어집니다.
Feat: "로그인 기능 개발"
로그인 API 개발
Resolves: #123
Ref: #456
Related to: #48, #45