본문 바로가기

CI & CD/Git

[Git] Git Commit Message Convention (.gitmessage)

728x90
좋은 커밋 메시지는 동료 개발자 또는 미래의 자신에게 변경사항을 전달하는 데 도움이 될 수 있다.

 

1. .gitmessage 파일 생성

2. .gitmessage 파일 내 템플릿 작성

########## Title ##########
<type>: title
############################

- content1
- content2

########## Footer ##########
# Resolves: 해결된 이슈
# Ref: 참고할 이슈
#############################

# ----- Type List -----
#   feat     : new feature
#   fix      : bug fix
#   refactor : refactoring production code
#   style    : formatting, missing semi colons, etc; no code change
#   docs     : changes to documentation or comments
#   test     : adding or refactoring tests
#              no productin code change
#   chore    : updating grunt tasks etc
#              no production code change
#   design   : css or UI/UX design modification
# ----------------------
feat: 새로운 기능을 추가한 경우
fix: 버그를 고친 경우
docs: 문서 수정
comment : 주석 추가 및 변경
design : CSS 등 사용자 UI 디자인 변경
refactor: 코드 리팩토링 (ex) 변수명 수정)
style: 코드의 변화와 관련없는 포맷이나 세미콜론을 놓친 것과 같은 부분의 수정
test: 테스트 코드 변경 
chore:  build와 관련된 부분, 패키지 매니저 설정 등 여러가지 production code와 무관한 부분 들을 의미한다. 말 그대로 자질구레한 일들
remove : 파일을 삭제하는 작업만 수행하는 경우
rename : 파일 혹은 폴더명 수정하거나 옮기는 작업만인 경우

 

3. 템플릿 등록

git config --global commit.template <.gitmessage 파일 경로>
반응형