정리/Git
[Git] Commit message template 설정
민발자
2024. 5. 13. 18:53
728x90
1️⃣ .gitmessage.txt 파일 생성
## 파일생성
touch ~/.gitmessage.txt
## 템플릿 작성
vim ~/.gitmessage.txt
📃 템플릿 예시
################
# <타입>: <제목> 의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내, 변경사항 명확히 작성, 끝에 마침표 금지
# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
################
# 본문(구체적인 내용)을 아랫줄에 작성
################
# 꼬리말(footer)을 아랫줄에 작성
################
# FEAT : 새로운 기능 추가
# FIX : 버그 수정
# DOCS : 문서 수정
# TEST : 테스트 코드 추가
# REFACTOR : 코드 리팩토링
# STYLE : 코드 의미에 영향을 주지 않는 변경사항
# CHORE : 빌드 부분 혹은 패키지 매니저 수정사항
# REMOVE : 코드/파일 삭제
# CONTENT : 글 업데이트
# DEPLOY : 배포
# BUILD : 빌드
# ETC : 기타
################
# Remember me ~
# Capitalize the subject line
# 제목줄은 대문자로 시작한다.
# Use the imperative mood in the subject line
# 제목줄은 명령어로 작성한다.
# Do not end the subject line with a period
# 제목줄은 마침표로 끝내지 않는다.
# Separate subject from body with a blank line
# 본문과 제목에는 빈줄을 넣어서 구분한다.
# Use the body to explain what and why vs. how
# 본문에는 "어떻게" 보다는 "왜"와 "무엇을" 설명한다.
# Can use multiple lines with "-" for bullet points in body
# 본문에 목록을 나타낼때는 "-"로 시작한다.
# ------------------
🔎 참고
https://coyo-hm.github.io/post/git-commit-template
https://coyo-hm.github.io/post/git-commit-template
coyo-hm.github.io
2️⃣ 적용하기
## 적용하기
git config --global commit.template ~/.gitmessage.txt
## 삭제하기
git config --global --unset commit.template
## vscode 사용하기
git config --global core.editor "code --wait"
## vscode 해제
git config --global --unset core.editor
728x90