커밋 메세지 구조
type(scope): subejct (essential)
body (optional)
footer (optional)
Java
복사
type (유형)
기본
•
feat : 새로운 기능
•
fix : 버그 수정
•
docs : 문서 수정
•
style : 서식, 세미콜론 누락 등
•
refactor : 코드를 리팩토링
•
test : 테스트 추가, 테스트 리팩토링
•
chore : 빌드 업데이트 등 설정을 변경
상세
•
design: 사용자 UI 디자인 변경 (CSS 등)
•
build: 빌드 파일 수정
•
ci: CI 설정 파일 수정
•
perf: 성능 개선
•
rename: 파일 혹은 폴더명을 수정만 한 경우
•
remove: 파일을 삭제만 한 경우
scope (범위)
•
변경된 코드가 속한 기능 / 모듈 / 디렉토리 지정한다.
◦
ex) auth, api, db
•
공통 부분 혹은 코어 부분에 해당하면 core 또는 all(*) 을 사용하거나 생략한다.
•
소괄호 안에 작성하며 띄어쓰기 없이 소문자 사용한다.
subject (제목)
•
짧고 명확하게 설명해야한다. (영문자 기준 50자 이내)
•
마침표로 끝나면 안되며, 영문자일 경우 대문자로 시작한다.
•
명령문 형태로 작성한다. (과거형 X)
◦
“~~ 추가” O, “~~ 추가했음” X
body (본문)
•
무엇을 변경했고, 왜 변경했는지 설명한다. (어떻게 변경했는지는 불필요하다)
•
각 줄은 72자를 넘지 않도록 한다.
footer (추가 정보)
•
이슈 번호를 언급한다.
◦
주로 Closes(종료), Fixes(수정), Resolves(해결), Ref(참고), Related to(관련) 키워드를 사용한다.
◦
ex) Fixes: #1, closes: #2
