[Git] git 커밋 메시지 컨벤션

📌 커밋 메시지란?

작업중인 로컬 디렉터리에서 git add을 해서 추가된 변경된 내용들을 설명해주는 글이다.

 

📌 commit 메시지 구조

• 3가지 파트로 나뉜다
• 각 파트는 빈줄로 구분한다

type: subject

body (옵션)

footer (옵션)

• type: subject
  • type
    • Feat : 새로운 기능 추가
    • Fix : 버그 수정
    • Docs : 문서 수정
    • Style : 코드 변경 없이 스타일만 변경(들여쓰기, 세미콜론 누락 등)
    • Refactor: 코드 리팩토링
    • Test : 테스트 코드의 추가, 수정, 삭제
    • Chore: 코드의 수정 없이 설정 변경(빌드 스크립트 수정, 패키지 매니저 설정 등)
    • Design : CSS 등 사용자 UI 디자인 변경
    • !BREAKING CHANGE : 커다란 API 변경
    • !HOTFIX : 급하게 치명적인 버그를 고쳐야 하는 경우
    • Comment : 필요한 주석 추가 및 변경
    • Rename : 파일 혹은 폴더명 변경 및 이동
    • Remove : 파일을 삭제하는 작업만 수행
  •  subject
    • 최대 50 글자, 마침표 및 특수기호 X
    • 영문으로 표기 시, 동사를 가장 앞에 두고 첫글자는 대문자로 작성(과거시제 X)
    • 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술

• body
  • 자세한 설명이 필요한 경우에 사용
  • 최대 72 글자
  • 어떻게 했는지가 아니라, 무엇을 왜 했는지 작성
• footer
  • "유형: #이슈 번호" 형식
  • issue tracker ID를 명시
  • 여러 개의 이슈 번호 적을 땐 쉼표로 구분
    • Fixes : 이슈 수정중(아직 해결 X)
    • Resolves : 이슈 해결
    • Ref : 참고할 이슈
    • Related to : 해당 커밋에 관련된 이슈 번호(아직 해결 X)

 

 

반응형

📌 commit 옵션

• -m
  • 해당 옵션은 커밋 메세지를 설정합니다.

git add file
git commit -m "commit message"

 

• -a or --all
  • 모든 상태의 파일을 자동으로 Commit(될 수 있으면 쓰지 않는 것을 추천)

git commit -a -m "ADD 블라블라

• --amend
  • 현재 staged된 변경 사항 또는 새 커밋 메시지로 푸쉬되지 않은 마지막 커밋 메시지를 다시 작성

git add .

git commit --amend -m "ADD 블라블라블라"

 

 

 

 

📌  좋은 커밋 메시지 작성법

⚡ 커밋 유형 지정

• Feat : 새로운 기능 추가
• Fix : 버그 수정
• Docs : 문서 수정
• Style : 코드 변경 없이 스타일만 변경(들여쓰기, 세미콜론 누락 등)
• Refactor: 코드 리팩토링
• Test : 테스트 코드의 추가, 수정, 삭제
• Chore: 코드의 수정 없이 설정 변경(빌드 스크립트 수정, 패키지 매니저 설정 등)
• Design : CSS 등 사용자 UI 디자인 변경
• !BREAKING CHANGE : 커다란 API 변경
• !HOTFIX : 급하게 치명적인 버그를 고쳐야 하는 경우
• Comment : 필요한 주석 추가 및 변경
• Rename : 파일 혹은 폴더명 변경 및 이동
• Remove : 파일을 삭제하는 작업만 수행

 

⚡ 제목과 본문을 빈 칸 한 줄 띄워 분리

• 여러 행으로 구성된 커밋 로그를 -m 스위치를 사용해서 입력하기는 어렵다 .
• 깃 커밋 에디터 사용법 참고

⚡ 제목 행을 50자로 제한

• 강제로 제한하는 것은 아니고 읽기 쉽고 간결하게 표현하기 위한 경험에 의한 규칙이다.

⚡  제목 행의 첫 글자는 대문자로 시작

readme file modification X
Readme file modification O

⚡ 제목 행 끝에 마침표를 넣지 않는다

Open the door. X
Open the door O

⚡ 제목 행에 명령문을 사용한다.

Create package

 

⚡ 본문은 한 줄 기준 72자 이하

⚡ 본문을 사용하여 변경 내용에 대해 어떻게 보다는 무엇과 왜를 설명 

 

⚡ 원래 문제가 무엇인지 이해한다고 가정하지 말고 확실하게 설명 추가

 

⚡ 자신의 코드가 직관적으로 바로 파악 할 수 있다고 생각하지 말자

 

⚡ 팀에서 정한 Commit 규칙을 따르자

 

 

 

 

---

Reference

좋은 커밋 메세지 작성하는 법: 실용적인 깃(Git) 가이드

[Git] 깃 커밋 메시지 작성법(git commit message) - 1