Commit Convention(Git)

김덕근·2023년 5월 22일
0

git

목록 보기
5/5

템플릿 생성

touch ~/.gitmessage.txt

템플릿 수정

vim ~/.gitmessage.txt

템플릿 적용

git config --global commit.template [.gitmessage.txt경로]
git config --global commit.template ~/.gitmessage.txt

템플릿 삭제

git config --global --unset commit.template

Git config 에 추가

.gitconfig 파일에 commit.template 항목에 기본 값으로 등록할 내용을 추가해준다.
여기서 나는 ~/.gitmessage라는 것을 전체 프로젝트에서 사용하도록 구성하겠다.

git config --global commit.template ~/.gitmessage

명령을 실행하면 .gitconfig 파일에 다음과같이 설정이된다.
[commit]
template = ~/.gitmessage


commit template❗

# 제목은 최대 50글자까지 아래에 작성: ex) Feat: Add Key mapping  

# 본문은 아래에 작성  

# 꼬릿말은 아래에 작성: ex) Github issue #23  

# --- COMMIT END ---  
#   <타입> 리스트  
#   feat        : 기능 (새로운 기능)  
#   fix         : 버그 (버그 수정)  
#   refactor    : 리팩토링  
#   design      : CSS 등 사용자 UI 디자인 변경  
#   comment     : 필요한 주석 추가 및 변경  
#   style       : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)  
#   docs        : 문서 수정 (문서 추가, 수정, 삭제, README)  
#   test        : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)  
#   chore       : 기타 변경사항 (빌드 스크립트 수정, assets, 패키지 매니저 등)  
#   init        : 초기 생성  
#   rename      : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 한 경우  
#   remove      : 파일을 삭제하는 작업만 수행한 경우  
# ------------------  
#   제목 첫 글자를 대문자로  
#   제목은 명령문으로  
#   제목 끝에 마침표(.) 금지  
#   제목과 본문을 한 줄 띄워 분리하기  
#   본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.  
#   본문에 여러줄의 메시지를 작성할 땐 "-"로 구분  
# ------------------  
#   <꼬리말>  
#   필수가 아닌 optioanl  
#   Fixes        :이슈 수정중 (아직 해결되지 않은 경우)  
#   Resolves     : 이슈 해결했을 때 사용  
#   Ref          : 참고할 이슈가 있을 때 사용  
#   Related to   : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)  
#   ex) Fixes: #47 Related to: #32, #21

템플릿 리스트 확인

git config -list
커밋시 템플릿 확인
git commit

profile
안녕하세요!

0개의 댓글