본인의 git message는 정리가 1도 안 되어있어서
알아보기 참 힘들었습니다. 다른 사람은 더 하겠죠. 그래서
Udacity의 git message convention을 참고하여
git message convention을 간략하게 정리해봤습니다.
git message template의 구조를 보며 설명하겠음.
템플릿을 사용할 프로젝트 .git 폴더의 위치에서 .gitmessage.txt 파일을 만들고
아래 Text를 복붙하시고, git commit을 해주면 해당 템플릿이 나타남
i를 눌러 수정하고 esc => :wq로 저장후 Push 합니다.
- 참고: Push하면 아래 Text에서 #는 모두 제외되니 걱정마셈. ㅇㅇ
# TK's commit message template
# 제목은 대문자로 시작합니다.
# 본문과 푸터는 선택 사항 입니다.
####### type: subject #######
####### body(option) #######
####### footer(option) #######
######## types ##########
# Feat : 새로운 기능을 추가할 경우
# Fix : 버그를 고친 경우
# Design : CSS 등 사용자 UI 디자인 변경
# !BREAKING CHANGE : 커다란 API 변경의 경우
# !HOTFIX : 급하게 치명적인 버그를 고쳐야하는 경우
# Style : 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
# Refactor : 프로덕션 코드 리팩토링
# Comment : 필요한 주석 추가 및 변경
# Docs : 문서를 수정한 경우
# Test : 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
# Chore : 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
# Rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
# Remove : 파일을 삭제하는 작업만 수행한 경우
##################
type: 어떤 의도로 커밋했는지를 type에 명시.
subject : 최대 50글자가 넘지 않도록 하고 마침표는 찍지 않음. 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기.
body: 긴 설명이 필요한 경우에 작성합니다. 어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성. 최대 75자를 넘기지 않도록.
footer : issue tracker ID를 명시하고 싶은 경우에 작성.
FE 뉴비