728x90
커밋 메시지 구조는 크게 3가지로 나뉜다(제목, 본문, 꼬리말)
type: Subject -> 제목
(한칸 띄우기)
body(생략 가능) -> 본문
(한칸 띄우기)
footer(생략 가능) -> 꼬리말
예시)
Feat: Add signin, signup
회원가입 기능, 로그인 기능 추가(예시를 위해 간단히 작성)
Resolves: #1
💡 첫 글자를 대문자 / 명령문 사용 (개조식구문) / 제목 끝에 마침표(.) 금지
제목과 본문을 한 줄 띄워 분리하기 본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
<Type>
| Feat | 새로운 기능 추가 |
| Fix | 버그 수정 |
| Refactor | 리팩토링 |
| Design | CSS 등 사용자 UI 디자인 변경 |
| Comment | 필요한 주석 추가 및 변경 |
| Style | 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음) |
| Docs | 문서 수정 (문서 추가, 수정, 삭제, README) |
| Test | 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음) |
| Chore | 기타 변경사항 (빌드 스크립트 수정, assets, 패키지 매니저 등) |
| Init | 초기 생성 |
| Rename | 파일 혹은 폴더명을 수정하거나 옮기는 작업만 한 경우 |
| Remove | 파일을 삭제하는 작업만 수행한 경우 |
<Body> (option)
1.한 줄당 72자 내로 작성
2.최대한 상세히 작성
3.어떻게 보다는 '무엇을', '왜' 변경했는지에 대해 작성
<Footer> (option)
1. 유형: #이슈 번호 의 형식으로 작성
2.이슈 트래커 ID를 작성
3.여러개의 이슈 번호는 ,로 구분
4.이슈 트래커 유형은 아래와 같다
Fixes 이슈 수정중 (아직 해결되지 않은 경우)
| Resolves | 이슈 해결했을 때 사용 |
| Ref | 참고할 이슈가 있을 때 사용 |
| Related to | 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우) |
ex) Fixes: #47 Related to: #32, #21
ex) Footer에 Fixes: #1 이라고 작성하고 commit을 할 경우, 자동으로 issue #1과 매칭이 된다. 또한, Resolves: #1 으로 이슈를 해결했다고 명시하면 그 이슈는 사라진다.
'4. Git' 카테고리의 다른 글
| [Git] master branch to main branch (1) | 2023.11.20 |
|---|---|
| [Git] 깃허브 파일명 변경하는 방법 (0) | 2023.11.14 |
| [Git] .gitignore (0) | 2022.09.08 |
