- Knowledge
git commit template - 그래서 commit convention 을 어떻게 외우지?
커밋 메시지 규칙을 쉽게 지키도록 git commit template를 설정하고 재사용할 수 있는 작성 템플릿을 소개합니다.
시리즈15편 중 11편Git 기초와 활용
- 01분산형 버전관리 시스템(Distributed Version Control System)이란?
- 02Git(깃)의 등장
- 03Git 의 장점 (왜 빠른건가요?)
- 04Git의 저장소 구조 및 워크플로우
- 05Git 시작하기 - 초기화 및 설정
- 06Git에서 autocrlf는 왜 설정해야 할까?
- 07Git에 올리면 안 되는 파일, .gitignore로 관리하기
- 08git tag 활용방법
- 09Semantic Version 관리 (v1.0.0-rc.1)
- 10Commit Message Convention (feat: 로그인 기능 추가)
- 11git commit template - 그래서 commit convention 을 어떻게 외우지?읽는 중
- 12Branch 사용 방법 (브랜치를 꼭 써야하나요?)
- 13git merge 어떻게 하면 될까? (merge 경우의 수)
- 14(중요) git rebase -i 로 깔끔하게 커밋 정리
- 15git stash - 커밋하기엔 애매할 때 잠시 보관
git commit convention 을 통해서, commit 을 일관성 있게 작성하는 방법을 배웠다.
그런데, type 종류를 내가 어떻게 외울 수 있을까?
footer 에 어떻게 기입해야 각종 서비스랑 연동될 수 있을까? (ex. Co-authored-by)
처음에 git commit convention 을 배우고 나서 고민했던 부분이다.
commit 을 작성할 때, 작성 가이드나 템플릿이 같이 나오면 얼마나 좋을까?
git commit template 를 활용하면 된다.
git commit template
shell
git config --global commit.template홈 폴더 아래에 .gitmessage 파일이 생성된다.
.gitmessage 에 아래의 내용을 기입한다.
(# 으로 기록된 내용은 주석으로써, 커밋 시에 자동으로 무시된다.)
Plain Text
# <타입>: <제목> (50자 이내, 마침표 없이)
# 예시: feat: 로그인 기능 추가
# 예시: fix: 주문 계산 오류 수정
# 아래 공백에 작성
# 바로 아래 공백은 유지 (제목과 본문 분리)
# [본문] 변경사항의 상세 내용 작성 (필요시)
# - 무엇을 변경했는지, 왜 변경했는지 구체적으로 작성
# - 여러 줄은 하이픈(-) 또는 불릿(*)으로 구분
# - 한 줄은 72자 이내로 작성 권장
# 예시:
# - 사용자 로그인 기능 구현
# - 아이디/비밀번호 입력 및 검증 로직 추가
# - 불필요한 임시 코드 제거
# 아래 공백에 작성
# [꼬릿말] (필요시)
# - 관련 이슈 번호, 참고 링크, 리뷰어 등
# 예시:
# Close #123
# Reviewed-by: john
# Ref: https://example.com/issue/456
# 아래 공백에 작성
# -------------------------------
# 타입 설명
# feat: 새로운 기능 추가
# fix: 버그 수정
# docs: 문서 수정
# test: 테스트 코드 추가/수정
# refact: 코드 리팩토링
# style: 코드 스타일 변경(포맷, 세미콜론 등)
# chore: 빌드/패키지/기타 잡일이후부터는 commit 을 할 때마다, 아래의 템플릿이 뜨게 된다.
갑자기 추워진 날, 진주에서
진주에서 하루종일 돌아다녔다

내 단점을 커버하는 동료와 함께.
새로운 프로젝트를 함께 준비하는 친구와의 저녁. 미운 점도 고마운 점도 있지만, 결국 같이 잘됐으면 좋겠다는 마음.

순천과 여수 여행3
마지막 하루. 공부랑 런닝으로 끝내기


댓글 0
이 글에 대한 생각을 자유롭게 남겨주세요.
댓글을 불러오는 중…