목차
Git Commit Message Rules
1. 7가지 규칙
- 제목과 본문을 빈 행으로 구분한다.
- 제목은 50글자 이내로 제한한다.
- 제목의 첫 글자는 대문자로 작성한다.
- 제목 끝에는 마침표를 넣지 않는다.
- 제목은 명령문으로 사용하며 과거형을 사용하지 않는다.
- 본문의 각 행은 72글자 내로 제한한다.
- 어떻게 보다는 무엇과 왜를 설명한다.
2. 커밋 메시지 구조
// Header, Body, Footer는 빈 행으로 구분한다.
타입: 주제(제목) // Header(헤더)
본문 // Body(바디)
바닥글 // Footer
- Header: 타입(해당 커밋의 성격), 필수
- Body: 상세 내용, 생략 가능
- Footer: 참조 정보 추가, 생략 가능
- Resolves: 해결한 이슈
- See also: 참고 이슈
2.1. Type
| 타입 이름 | 내용 |
|---|---|
| feat | 새로운 기능 추가 |
| fix | 버그 수정 |
| build | 빌드 관련 파일 수정 / 모듈 설치 또는 삭제 |
| chore | 빌드 업무 수정, 패키지 매니지 수정 (gitignore 수정 등) |
| ci | ci 설정 수정 |
| docs | 문서 수정 |
| style | 코드 스타일, 포맷 등 기능 수정 X |
| refactor | 코드 리팩토링 |
| test | 테스트 코드 수정 |
| perf | 성능 개선 |
| rename | 파일/폴더명 수정 |
| remove | 파일 삭제 |
| design | 사용자 UI 디자인 변경 (CSS 등) |
2.2. 관련 이슈
| 사용 시점 | 사용 키워드 |
|---|---|
| 해결 | Closes(종료), Fixes(수정), Resolves(해결) |
| 참고 | Ref(참고), Related to(관련), See also(참고) |
Comments