[Git] Github commit message 템플릿 화하기

목차

 

 

 왜 템플릿를 하는가?

git commit message 를 작성하다보니 비슷하게 반복하는 내용을 적어줘야하는 불편함이 생겼다. 그래서 git commit message를 템플릿화 하는 방법이있지 않을까 해서 알아본 내용을 공유하려고 한다.

 

 적용방법

 

템플릿화 할 txt파일 생성

• 템플릿을 적용하고싶은 프로젝트 root에 commit-template.txt라는 파일을 생성해준다.

commit-template.txt

# 타입: feat, fix, docs, style, refactor, test, chore 중 하나
# 스코프: 변경된 코드의 범위를 지정
# 제목: 50자 이내로 간결하게 변경 사항을 요약

feat(auth): add OAuth2 login

# 본문: 변경 사항에 대한 자세한 설명
# 여러 줄로 작성 가능하며, 변경한 이유, 방법 등을 상세히 작성

- Added OAuth2 login functionality using Google and Facebook
- Updated user model to include OAuth2 provider details
- Refactored authentication middleware to support OAuth2

# 푸터: 관련된 이슈 번호나 추가 정보를 명시
# 예: Closes #123, BREAKING CHANGE 등

Closes #101

 

커밋 메시지 템플릿 적용

 git config commit.template commit-template.txt

• 프로젝트 루트 로 이동을하고 위 명령어를 실행해 template를 적용 시켜준다.

 

커밋 템플릿 불러와서 commit 하는법

git commit

• 해당 명령어를 실행하면 COMMIT_EDITMSG가 열린다.

 

커밋 메시지 저장

• COMMIT_EDITMSG 창을 X버튼을 눌러 창을 닫거나 해당 창에 focus된 상태에서 Ctrl + w 를통해 저장할 수 있다.

커밋 push

• 커밋 push는 원래 하던대로 git push 명령어를 통해 해주면 끝