[Git] Git Commit Convention, 깃 커밋 컨벤션 설정

형상관리 툴인 Git을 사용하면서 Commit을 할 때 Commit Message를 작성하는 규칙이다.

 

1. Commit 메시지 구조

 

기본 적인 커밋 메시지 구조는 제목,본문,꼬리말 세가지 파트로 나누고, 각 파트는 빈줄을 두어 구분한다.

제목) type : subject
본문) body 
꼬릿말) footer

 

2. Commit Type

타입은 태그와 제목으로 구성되고, 태그는 영어로 쓰되 첫 문자는 대문자로 한다.

태그 : 제목의 형태이며, : 뒤에 space가 있음에 유의한다.

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 수정
style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
refactor : 코드 리펙토링
test : 테스트 코드, 리펙토링 테스트 코드 추가
chore : 빌드 업무 수정, 패키지 매니저 수정

 

3. Subject

• 제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않는다.
• 영어로 Subject 작성 시 첫 글자는 대문자로 표기한다.

# Add : 추가
# Remove : 삭제
# Simplify : 단순화
# Update : 보완
# Implement : 구현
# Prevent : 방지
# Move : 이동
# Rename : 이름 변경

• 제목은 개조식 구문으로 작성한다. --> 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술을 의미.

* Fixed --> Fix
* Added --> Add
* Modified --> Modify

 

4. 본문(Body), 꼬릿말(footer)

 

• 본문(Body)
  • 본문은 한 줄 당 72자 내로 작성한다.
  • 본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
  • 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.
•  꼬릿말(footer)
  • 꼬리말은 optional이고 이슈 트래커 ID를 작성한다.
  • 꼬리말은 "유형: #이슈 번호" 형식으로 사용한다.
  • 여러 개의 이슈 번호를 적을 때는 쉼표(,)로 구분한다.
  • 이슈 트래커 유형은 다음 중 하나를 사용한다.

- Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
- Resolves: 이슈를 해결했을 때 사용
- Ref: 참고할 이슈가 있을 때 사용
- Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
ex) Fixes: #45 Related to: #34, #23

 

5. Commit 예시

Feat: "리스트/image 로직"

리스트/image 수동저장 초기세팅
폴더명 정리

Resolves: #44
Related to: #21, #26, #40, #42, #43

6. Gitmoji

"Gitmoji"는 'git'과 'emoji'를 결합한 용어로, Git 커밋 메시지에 이모지를 사용한다.

이모지를 통해 커밋의 의도를 시각적으로 표현할 수 있고, 작업 내용을 쉽고 빠르게 이해하는 데 도움을  준다.

 

gitmoji github 캡처

 

IntelliJ에서 plugin으로 Gitmoji  사용하기

1) setting에서 Plugins 를 검색하고, Marketplace 에서 'gitmoji' 검색해서 설치한다. 

2) commit할때 Gitmoji 적용

• 자주 사용하는 Gitmoji 리스트 확인하기
• Git Message를 Template등록 후 사용할 수도 있다. 참고

7. Commit 메세지 확인하기 

commit 메세지 가독성이 훨씬 높아졌다.