[Git] Commit Message Convention

bien·2023년 3월 12일
0

git

목록 보기
1/1

commit message는 일반적으로 사용되는 양식이 분명한 것 같아 따로 정리한다.

1. Message Structure

type: Subject

body

footer

각 요소마다 line을 띄워 분리한다.

2. The Type

type은 다음 중 하나를 선택한다.

  • feat: 새로운 기능
  • fix: 버그 수정
  • docs: 문서의 수정
  • style: 포맷팅, 놓친 새미콜론 추가 등, 코드에 변경이 없는 경우
  • refactor: 프로덕션 코드의 리팩토링
  • test: 테스트 추가, 테스트 리팩토링
  • chore: 설정 변경

3. The Subject

50자 이하로 기술하고, 대문자로 시작하며, 맞침표를 찍지 않는다.
명령조로 서술한다.

4. The Body

body로 추가 설명이 필요한 경우에만 기재한다.(subject로 충분한 경우 작성하지 않는다)
어떻게가 아니라, 무엇을 혹은 왜 커밋했는지 설명할 것.
글자 수는 72자 이하로 제한한다.

issue tracker ID를 명시하고 싶은 경우 사용한다.

6. gitmoji

gitmoji에 대해 잘 설명해놓은 블로그
https://siyoon210.tistory.com/56

profile
Good Luck!

0개의 댓글