Git & Github
[Conventional commit] 커밋 메시지 작성방법
GOMSHIKI
2024. 6. 24. 12:11
반응형
1. Conventional commit 구조
2. 구조 설명
- 옵션(option) : 변경사항 범위를 나타냄. 주로 모듈이나 파일이름 사용
- 제목(subject) : 50자 내로 간결하게 작성하며, 첫 글자는 소문자로 쓰고 마침표를 사용하자 않음
- 본문(body) : 변경사항에 대한 세부 설명 작성. 한 줄에 72자를 넘지 않도록해야하며, 제목과 본문 사이 빈 줄을 넣어야 함
- 푸터(footer) : 이슈 ID 등과 같은 참조 정보 기입. 생략가능
- 타입(type) : 커밋의 목적을 명확히 하기 위해 아래 타입을 참고하여 사용
항목 | 설명 |
feat | 새로운 기능 추가 |
fix | 버그 수정 |
docs | 문서 수정 |
style | 코드 포맷팅, 세미콜론 누락 등 코드 변경이 없는 수정 |
refactor | 리팩토링 |
test | 테스트 추가 혹은 수정 |
chore | 빌드 작업이나 패키지 관리자 설정 등 기타 변경 |
※ 작성 예시
반응형