[Git] git commit message convention (커밋 메시지 규칙)

협업 중 커밋 메시지는 어떠한 기능을 만들고 무엇을 수정하였는지 쉽게 알아보고 찾을 수 있도록 커밋 메시지 컨벤션이 중요하다고 생각합니다.

 

Commit Type

Tag Name	Description
Feat	새로운 기능을 추가
Fix	버그 수정
Design	CSS 등 UI 디자인 변경
Style	코드 포맷 변경, 세미 클론 누락, 코드 수정이 없는 경우
Docs	문서 수정
Refactor	코드 리팩토링
Comment	필요한 주석 추가 및 변경
Test	테스트 코드, 리팩토링 테스트 코드 추가
Chore	빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음
Rename	파일 혹은 폴더명을 수정하거나 옮기는 작업의 경우
Remove	파일을 삭제하는 작업만 하는 경우

예시

[Feat] 로그인 기능 구현

비밀번호 5회 오류 시 비밀번호 찾기 페이지로 이동

git message template 생성

commit 할 때 기본적으로 보여질 Template을 만들어 사용 할 수 있는데 현재 git이 설치되어 있는 프로젝트 루트 디렉토리에 .gitmessage.txt 파일을 생성 후 사용하면 된다.

# my commit message template
# 본문과 푸터는 선택 사항입니다.
##################
# [type] Subject (아래에 작성)

# Body(아래에 작성)

# Footer(아래에 작성) (특정 ID가 있는 경우)

##################
# Feat: 새로운 기능 추가
# Fix: 버그 수정
# Docs: 문서 수정
# Style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
# Refactor: 코드 리팩토링
# Test: 테스트 코드, 리팩토링 테스트 코드 추가
# Chore: 빌드 업무 수정, 패키지 매니저 수정, production code와 무관한 부분들 (.gitignore, build.gradle 같은)
# Comment: 주석 추가 및 변경
# Remove: 파일, 폴더 삭제
# Rename: 파일, 폴더명 수정

# 예시
# [Feat] 로그인 기능 구현

# 비밀번호 5회 오류 시 비밀번호 찾기 페이지로 이동

# :12341234

 

이렇게 파일을 생성하고 나서 git config에 커밋 템플릿을 등록해주면 된다

git config --global commit.template .gitmessage.txt

 

그 후

git add 작업한 파일
git commit

 

명령어를 치면 내가 등록 해놓은 템플릿이 나오고 i(insert mode) 를 누르면 입력모드가 되고 커밋 메세지를 작성하고 :wq (저장) 하면 된다. 그 후 push 해주면 원격 브랜치에 정상적으로 git hub 또는 git lab 에서 확인 가능하다.

(참고로 # 은 주석처리되어 커밋 메시지에 포함되지 않습니다.)