Commit message 7가지 규칙
1. 제목과 본문을 빈 행으로 구분한다
2. 제목을 50글자 내로 제한
3. 제목 첫 글자는 대문자로 작성
4. 제목 끝에 마침표 넣지 않기
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않는다
6. 본문의 각 행은 72글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명한다
Commit message 구조
<type>: <subject>
<body>
<footer>
Type
- feat : 새로운 기능에 대한 커밋
- fix : 버그 수정에 대한 커밋
- build : 빌드 관련 파일 수정에 대한 커밋
- chore : 그 외 자잘한 수정에 대한 커밋
- ci : CI관련 설정 수정에 대한 커밋
- docs : 문서 수정에 대한 커밋
- style : 코드 스타일 혹은 포맷 등에 관한 커밋
- refactor : 코드 리팩토링에 대한 커밋
- test : 테스트 코드 수정에 대한 커밋
Subject
Type과 함께 헤더 자리에 위치한다. ex) feat: Add login (로그인 API를 추가했다는 의미이다.)
Body
헤더에서 표현 가능하다면 생략할 수 있다. 아니라면 본문을 작성하면 된다.
Footer
어떤 issue에 대한 commit 인지 issue number를 담고 있다.
참고
https://beomseok95.tistory.com/328
[Git] 좋은 커밋 메세지 작성하기위한 규칙들
좋은 커밋 메시지 작성하기 위한 규칙들 코드를 작성하면서 어려운것들중 하나는 이름을 어떻게 짓는지에 대한 고민 바로`Naming` 일 것입니다. 클래스, 함수, 변수 등등 많은 이름을 고민하지만
beomseok95.tistory.com