깃 커밋 메시지 컨벤션 (Git Commit Message Convention)

한재민·2025년 2월 20일

용어정리

목록 보기
12/33
post-thumbnail

최근에서야 깃 컨벤션을 알게되어 적용시켜 커밋메세지를 작성하고있다.
매번 글찾아서 보면서 적기 불편해서 따로 정리를 하려한다.

커밋 메시지 기본 구조

Commit Message 구조는 제목, 본문, 꼬리말 세가지 파트로 나누고,
빈줄로 구분한다.

type: subject

body ( 선택 사항 )

footer ( 선택 사항 )

커밋 타입 (type)

타입은 태그와 제목으로 구성,
태그는 영어로 쓰고, 첫 문자는 대문자
feat : 새로운 기능 추가

태그 이름설명
Feat새로운 기능을 추가할 경우
Fix버그를 고친 경우
!BREAKING CHANGE커다란 API 변경의 경우
!HOTFIX급하게 치명적인 버그를 고쳐야하는 경우
Style코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor프로덕션 코드 리팩토링
Comment문서를 수정한 경우
Test빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove파일을 삭제하는 작업만 수행한 경우

제목 ( Subject )

제목은 간결하고 요점만 50글자 이내로 작성하고, 마침표 및 특수기호 사용 X
영문으로 표기하는 경우 동사(원형)를 가장 앞에두고 첫글자는 대문자로 표기
과거 시제 사용 X

Added -> Add
Fixed -> Fix

본문 ( Body )

본문은 한 줄 당 72자 내로 작성
본문 내용은 양에 구애받지 않고 최대한 상세히 작성
본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 설명


  • 꼬리말은 optional이고 이슈 트래커 ID를 작성
  • 꼬리말은 유형: #이슈 번호 형식으로 사용
  • 여러개의 이슈 번호를 적을 때는 쉼표(,)로 구분
  • 이슈 트래커 유형
    • Fixes : 이슈 수정중
    • Resolves : 이슈를 해결했을 때
    • Ref : 참고할 이슈가 있을 대
    • Related to : 해당 커밋에 관련된 이슈번호

커멧 메시지 Emoji

EmojiDescription
🎨코드의 형식 / 구조를 개선 할 때
📰새 파일을 만들 때
📝사소한 코드 또는 언어를 변경할 때
🐎성능을 향상시킬 때
📚문서를 쓸 때
🐛버그 reporting할 때, @FIXME 주석 태그 삽입
🚑버그를 고칠 때
🔥코드 또는 파일 제거할 때 , @CHANGED주석 태그와 함께
🚜파일 구조를 변경할 때 . 🎨과 함께 사용
🔨코드를 리팩토링 할 때
💄UI / style 개선시
♿️접근성을 향상시킬 때
🚧WIP (진행중인 작업)에 커밋, @REVIEW주석 태그와 함께 사용
💎New Release
🔖버전 태그
새로운 기능을 소개 할 때
⚡️도입 할 때 이전 버전과 호환되지 않는 특징, @CHANGED주석 태그 사용
💡새로운 아이디어, @IDEA주석 태그
🚀배포 / 개발 작업 과 관련된 모든 것

깃 컨벤션을 알기 전 커밋 메시지와
깃 컨벤션을 어느정도 따라하며 작성한 커밋 메시지의
차이가 정말 큰거같다.

profile
유니티 클라이언트 취업준비중입니다..

0개의 댓글