좋은 커밋 메시지 작성하기 위한 규칙들
코드를 작성하면서 어려운것들중 하나는 이름을 어떻게 짓는지에 대한 고민 바로`Naming` 일 것입니다.
클래스, 함수, 변수 등등 많은 이름을 고민하지만 그 중 하나인 커밋 메시지를 어떻게 작성하여야
좋은 커밋 메시지일지에 대하여 알아보도록 하겠습니다.
커밋 메시지의 7가지 규칙
1. 제목과 본문을 빈 행으로 구분한다
2. 제목을 50글자 내로 제한
3. 제목 첫 글자는 대문자로 작성
4. 제목 끝에 마침표 넣지 않기
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
6. 본문의 각 행은 72글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명한다
커밋 메시지 구조
헤더는 필수이며, 범위(scope), 본문(body), 바닥글(footer)은 선택사항입니다.
<type>(<scope>): <subject> -- 헤더
<BLANK LINE>
<body> -- 본문
<BLANK LINE>
<footer> -- 바닥글
<type>은 해당 커밋의 성격을 나타내며 아래 중 하나여야 합니다
feat : 새로운 기능에 대한 커밋
fix : 버그 수정에 대한 커밋
build : 빌드 관련 파일 수정에 대한 커밋
chore : 그 외 자잘한 수정에 대한 커밋
ci : CI관련 설정 수정에 대한 커밋
docs : 문서 수정에 대한 커밋
style : 코드 스타일 혹은 포맷 등에 관한 커밋
refactor : 코드 리팩토링에 대한 커밋
test : 테스트 코드 수정에 대한 커밋
<body>는 본문으로 헤더로 표현할 수 없는 상세한 내용을 적습니다.
헤더로 표현이 가능하다면 생략 가능합니다.
<footer>는 바닥글로 어떤 이슈에서 왔는지 같은 참조 정보들을 추가하는 용도로 사용합니다
예를 들어 특정 이슈를 참조하려면 close #1233 과 같이 추가하면 됩니다.
close는 이슈를 참조하면서 main브랜치로 푸시될 때 이슈를 닫게 됩니다. [이슈링크 및 닫는참조키워드]
여러 커밋 메시지 예시들
github.com/angular/angular/commits/master
참고
'Git' 카테고리의 다른 글
| git rebase -i 알아보기 (2) | 2019.09.09 |
|---|---|
| Git Flow 란 ? (1) | 2019.08.05 |
| Git 자주쓰이는 명령어 모음 (4) | 2019.03.14 |
| GIt 명령어 배우기 -3 cherry-pick,인터렉티브 리베이스 (4) | 2019.02.11 |
| GIt 명령어 배우기 -2 커밋트리[Commit tree]에서 이동하는 방법( branch -f , reset, revert , ^, ~) (4) | 2019.02.07 |
댓글