티스토리 뷰

Tech/Git

[Git] Commit Message Convention

peachh 2021. 5. 1. 01:50
728x90

 

Commit Message는 머리글(header)-본문(body)-바닥글(footer) 구조를 가지며 머리글과 본문, 본문과 바닥글 사이에는 빈 줄이 존재해야 한다.

<type> : <subject>

<body>

<footer>

 

Header (essential)

  • 50자 이하로 작성
  • 첫 문자는 대문자로 작성
  • 마침표는 생략
  • 명령문 사용 (과거형 X)

    \<type\>

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • build : 빌드 관련 파일 수정
  • chore : 그 외 수정
  • docs : 문서 수정
  • style : 코드 스타일 또는 포맷 수정
  • refactor : 리팩토링
  • test : 테스트 코드 수정

 

Body (optional)

머리글에 표현할 수 없는 상세한 내용 작성

  • 각 행은 72자 이하로 작성
  • How보다는 What/Why를 설명

 

Footer (optional)

관련된 이슈를 작성

  • 같은 저장소의 이슈 : KEYWORD #ISSUE_NUMBER
  • 다른 저장소의 이슈 : KEYWORD OWNER/REPOSITORY#ISSUE_NUMBER
  • 여러 개의 이슈 작성 시 각각을 full syntax로 표기하며 콤마(,)로 구분
728x90
«   2024/05   »
1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 31
공지사항
링크
Total
Today
Yesterday