[Git] git commit message 작성 및 적용하기 (commit convention)

Git을 사용하며 협업할 때는 commit convention 등을 지정하면 코드 가독성이 증가하여 원활환 소통에 큰 도움이 된다.

특히 commit message를 지정해 두면 각 commit이 어떤 내용이고, 무엇을 위한 commit이며 무엇을 수정했는지 확인할 수 있어 유익하다.

 

Git Commit Message 규칙

1. 제목(title)과 본문은 개행하여 분리한다.

2. 제목 행은 영문 기준 50자 이내로 작성한다.

3. 제목 행 첫 글자는 대문자로 작성한다.

4. 제목 행 끝에 마침표(.) 사용 금지

5. 제목 행은 명령문을 사용한다.

6. 본문은 72자 단위로 개행한다.

7. How보다는 what과 why를 설명한다.

 

Commit Message 구조

Type: Subject

Body

Footer

 

Type은 각 commit의 목적, 분류 등을 의미한다. 아래 템플릿을 보면 이해할 수 있을 것이다.

 

---

템플릿 파일 생성하기

1. .git이 있는 현재 폴더 위치에서 다음 명령어를 통해 .gitmessage.txt 파일을 생성한다.

touch .gitmessage.txt

 

2. 생성된 .gitmessage.txt 파일에 들어가 커밋 메세지 템플릿을 복사-붙여넣기한 후 저장한다. (원한다면 수정)

# <타입> : <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
# 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성

################

# 본문(추가 설명)을 아랫줄에 작성

################
# 꼬릿말(footer)을 아랫줄에 작성 (관련된 이슈 번호 등 추가)
# Resolves: #123        | 꼬리말 => 이슈 123을 해결했으며,
# Ref: #456             | 이슈 456 를 참고해야하며,
# Related to: #48, #45  | 현재 커밋에서 아직 이슈 48 과 45 가 해결되지 않았다.

################
# feat : 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refactor : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
# cicd : CI/CD 관련 설정
################

 

#으로 시작하는 부분은 주석으로, 원격 저장소 커밋에서는 해당 부분을 확인할 수 없다.

즉 주석 사이사이에 템플릿에 따라 원하는 커밋 내용을 작성하면 된다.

 

템플릿 설정하기

해당 폴더의 터미널에서 아래 명령어를 통해 방금 저장한 템플릿을 설정해주자.

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

 

---

템플릿이 잘 설정되었는지 테스트해 보겠다.

 

우선 변경사항이 있는 파일을 Staged 상태로 변환한 후, commit 명령어를 실행한다.

git add .
git commit

 

VScode에서 COMMIT_EDITMSG 파일이 열릴 것이다.

 

해당 파일에 원하는 커밋 내용을 입력한다.

 

파일을 저장 후 닫기 (Ctrl+W)하면 commit이 완료된다. 마지막으로 아래 명령어를 통해 원격 저장소에 올린다.

git push