Git 커밋 메시지 규칙 - JuHyun419/one-line-course GitHub Wiki

🎵 Git 커밋 메시지 규칙

{타입}: {메세지}

{본문}

타입

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 문법, 포맷팅
• refactor: 코드 리팩토링
• test: 테스트 코드

메세지

• 해당 커밋에 대한 설명문
• 보통 현재형 동사와 함께 명령어로 작성
• 첫 글자는 대문자, 나머지는 소문자로 작성
  • ex) feat{타입}: Add google-oauth{메세지}
• 메세지를 통해 최대한 해당 커밋에 대해 파악이 가능하도록 작성

본문

• {타입}: {메세지} 로 표현할 수 없는 상세 내용을 적는 부분
• 따라서, {타입}: {메세지} 로 표현이 가능하다면 생략 가능

좋은 Commit을 위한 7가지 약속(영어 기준)

제목과 본문을 한 줄 띄워 분리하기
제목은 영문 기준 50자 이내로
제목 첫글자를 대문자로
제목 끝에 . 금지
제목은 명령조로
본문은 영문 기준 72자마다 줄 바꾸기
본문은 어떻게 보다 무엇을, 왜 에 맞춰서 작성하기
좋은 git 커밋 메시지를 작성하기 위한 7가지 약속