본문 바로가기
LEARN/NEED

[Git] 깃 커밋 메시지 컨벤션 Commit Message Convention

by 아이엠제니 2024. 4. 11.

 


 

 

 

1. Message Structure

type: Subject

body

footer
  • 제목은 메시지 타입과 제목으로 구성됨

 

 

2. The Type

Feat: 수시입출금 조회 기능 추가

타입은 제목 내에 포함되며, 다음 타입 중 하나일 수 있음

  1. Feat: 새로운 기능 추가
  2. Fix: 버그 수정
  3. Docs: 문서 변경 사항 (추가, 수정, 삭제)
  4. Style: 서식 지정, 세미콜론 누락 등 코드 변경 없을 경우
  5. Refactor: 코드 리팩토링
  6. Test: 테스트 추가, 테스트 리팩토링 등. 비즈니스 로직에 변경 없는 경우
  7. Chore: 패키지 관리자 구성 등 업데이트. 코드 변경 없음

 

추가

8. Build: 빌드 관련 파일 수정

 

 

3. The Subject

  • 제목은 50자 이하
  • 대문자로 시작
  • 마침표로 끝나서는 안 됨
  • 제목에 커밋 타입 함께 작성
  • 커밋이 무엇을 했는가 보다, 무엇을 하는지를 설명하며, 명령어 어조를 사용함

 

 

4. The Body

  • 커밋에 약간의 설명과 컨텍스트가 필요한 경우에만 사용됨
  • 커밋의 방법이 아닌 내용과 이유를 설명할 때 본문 사용

 

 

5. Footer

  • 선택 사항
  • 이슈 트래컬 ID를 참조하는 데 사용됨

 

 

 

참고
Udacity Git Commit Message Style Guide
https://udacity.github.io/git-styleguide

 

 

 

300x250