Type
Type 키워드 |
사용 시점 |
Feat |
새로운 기능 추가 |
Fix |
버그 수정 |
Docs |
문서 수정 |
Style |
코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)기능 수정이 없는 경우 |
Test |
테스트 코드, 리팩토링 테스트 코드 추가 |
Refactor |
코드 리팩토링 |
CI |
CI 설정 파일 수정 |
CD |
CD 설정 파일 수정 |
Perf |
성능 개선 |
Chore |
빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등) |
Rename |
파일 혹은 폴더명을 수정만 한 경우 |
Remove |
파일을 삭제만 한 경우 |
Add |
코드나 테스트, 예저 문서등의 추가 생성이 있는 경우 |
Improve |
향상이 있는 경우, 호환성, 검증 기능, 접근성 등이 될 수 있음 |
Move |
코드의 이동이 있는 경우 |
Updated |
계정이나 버전 업데이트가 있을 때 사용, 주로 코드보다는 문서, 리소스, 라이브러리 등에 사용 |
Comment |
필요한 주석 추가 및 변경 |
Footer
사용 시점 |
사용 키워드 |
해결 |
Closes(종료), Fixes(수정), Resolves(해결) |
참고 |
gor |
Commit Message 구조
################
# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) Feat : 로그인 기능 추가 # 이슈번호
# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
# '왜'라는 것에 초점을 맞춰 작성
################
# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
# 해결 -> Closes(종료), Fixes(수정), Resolves(해결)
# 참고 -> Ref(참고), Related to(관련), See also(참고)
# 예) Close #7
################
# Feat : 새로운 기능 추가
# Fix : 버그 수정
# Docs : 문서 수정
# Test : 테스트 코드, 리팩토링 테스트 코드 추가
# Refact : 코드 리팩토링
# Style : 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)기능 수정이 없는 경우
# Ci : CI 설정 파일 수정
# Perf : 성능 개선
# Chore : 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)
# Rename : 파일 혹은 폴더명을 수정만 한 경우
# Remove : 파일을 삭제만 한 경우
################
Commit 템플릿 적용 명령어
git config --local commit.template .gitmessage.txt
템플릿 설정 방법: https://velog.io/@bky373/Git-커밋-메시지-템플릿