본문 바로가기

Git

[Git] commit 메시지 작성법

commit 메시지 구조

type: Subject

body

footer

 

1. 커밋 유형 지정 type

  • FEAT: 새로운 기능 추가
  • FIX: 버그 수정
  • BUILD: 빌드 관련 파일 수정
  • TEST: 테스트 코드, 리팩토링 테스트 코드 추가
  • DOCS: 문서 추가/수정/삭제
  • CI: CI 관련 설정 수정
  • STYLE: 스타일 관련 기능 (코드 포맷팅, 세미콜론 누락, 프로덕션 코드 변경 없음)
  • DESIGN: CSS 등 사용자 UI 디자인 변경
  • COMMENT: 주석 추가 및 변경
  • RENAME: 파일 혹은 폴더명 수정(이동)
  • REMOVE: 파일 삭제
  • REFACTOR: 코드 리팩토링
  • CHORE: 기타 변경사항. 빌드 스크립트, 패키지 매니저 수정 등 (gitignore 수정 같은 경우, 프로덕션 코드 변경 없음)
  • !BREAKING CHANGE: 커다란 API 변경
  • !HOTFIX: 치명적인 버그가 발생. 수정할 필요가 있음

2. 제목 Subject

  • 커밋 유형 포함
  • 제목과 본문을 빈 행으로 분리
  • 50자로 제한
  • 첫 글자는 대문자로 시작
  • 마침표 X
  • 명령문 사용

3. 본문 body (선택 사항)

  • 변경한 내용과 이유 설명 (how 보다 what, why 설명)
  • 72자로 제한
  • 명확하게 설명
  • 팀에서 정한 커밋 규칙에 따라

4. 꼬리말 footer (선택 사항)

  • Issue tracker ID 명시
  • 해결: 이슈 해결 시 사용
  • 관련: 해당 커밋에 관련된 이슈 번호
  • 참고: 참고할 이슈가 있는 경우

해결: #123

관련: #321

참고: #222

 

commit 메시지 예시

FEAT: 신규 RFID 인식 기능 추가(#123)

신규 RFID 인식 기능 추가
 -RFIDReader.java: 사용자 요구사항으로 인한 RFID 인식 기능 추가

해결: #123