스프링 부트와 JPA로 QNA 게시판 만들기 프로젝트를 진행하며 Type없이 커밋메시지를 작성하고 있었는데, 이번에 페어와 함께 웹 서버 만들기 프로젝트를 진행하며 커밋 메시지 작성 방식을 변겅하게 되었다.
Before
After
타입을 적어주니 커밋메시지가 훨씬 이해하기 쉬워졌다. 익숙해지기 전까지는 커밋 메시지 작성에 참고할 템플릿이 있으면 좋을 것 같다는 생각이 들어 커밋 메시지 템플릿을 추가해보려고 한다.
1. 템플릿 파일 생성일 생성
- 커밋 메시지 템플릿을 저장할
~/.gitmessage.txt파일을 만들어 준다.
touch ~/.gitmessage.txt2. 커밋 템플릿 저장
- 사용하는 에디터(e.g.
code ~/.gitmessage.txt)로.gitmessage.txt파일을 연 후 커밋 템플릿 저장한다.
# <type>: <subject>
##### Subject 50 characters ################# -> |
# Body Message
######## Body 72 characters ####################################### -> |
# Issue Tracker Number or URL
# --- COMMIT END ---
# Type can be
# feat : new feature
# fix : bug fix
# refactor: refactoring production code
# style : formatting, missing semi colons, etc; no code change
# docs : changes to documentation
# test : adding or refactoring tests
# no productin code change
# chore : updating grunt tasks etc
# no production code change
# ------------------
# 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
# ------------------3. 깃 config 설정
.gitconfig파일의 commit 템플릿 기본값으로 ~/.gitmessage를 설정해준다.
git config --global commit.template ~/.gitmessage.txt이제 git commit 명령어 입력 시 커밋 메시지 템플릿을 확인할 수 있다😆
Source
