git commit template 설정하기

팀 협업 전 git commit 메세지 양식을 정해 양식에 맞춰 commit메세지를 작성 할 수 있게 세팅을 해줬다.

템플릿 파일 작성하기

템플릿 내용을 넣을 파일을 만들어 준다. 처음에는 사용할 프로젝트 디렉토리 내부에 만들려 했으나 경로 중간에 한글로 만들어진 디렉토리가 있어서그런지 잘 설정이 되지 않았다. 그래서 /Users/{xxx}/git-template/.git-commit-template 경로로 템플릿 파일을 만들어 줬다. ( {xxx}은 본인유저 네임이 들어간다.)
.git-commit-template에 넣을 양식은 다음과 같이 넣어줬다.

# <[type]>: <subject>
##### Subject 50 characters ################# ->


# Body Message
######## Body 72 characters ####################################### ->

# Issue Tracker Number or URL (optional) ->

# --- COMMIT END ---
# Type can be
#   feat    : 새로운 기능 추가
#   fix     : 버그/오타(typo)/로직 등 코드를 수정한 경우
#   refactor: 코드 리팩토링
#   style   : 코드 포맷팅, 세미콜론 누락 수정 등 내부 로직 변경이 없이 코드를 수정한 경우
#   docs    : README 문서 수정
#   test    : 테스트 코드, 리팩토링 테스트 코드 추가
#   chore   : 빌드 업무 수정, 패키지 매니저 수정
#   remove  : 코드/파일 삭제
#   dep     : 패키지 설치/삭제 등 의존성 관련 수정
#   etc     : 기타
# ------------------
# Remember me ~
#   Capitalize the subject line
#     제목줄은 대문자로 시작한다.
#   Use the imperative mood in the subject line
#     제목줄은 명령어로 작성한다.
#   Do not end the subject line with a period
#     제목줄은 마침표로 끝내지 않는다.
#   Separate subject from body with a blank line
#     본문과 제목에는 빈줄을 넣어서 구분한다.
#   Use the body to explain what and why vs. how
#     본문에는 "어떻게" 보다는 "왜"와 "무엇을" 설명한다.
#   Can use multiple lines with "-" for bullet points in body
#     본문에 목록을 나타낼때는 "-"로 시작한다.
# ------------------
#   <꼬리말>  
#   필수가 아닌 optioanl  
#   Fixes        :이슈 수정중 (아직 해결되지 않은 경우)  
#   Resolves     : 이슈 해결했을 때 사용  
#   Ref          : 참고할 이슈가 있을 때 사용  
#   Related to   : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)  
#   ex) Fixes: #47 Related to: #32, #21

Template 적용시키기

템플릿 파일을 만들어 줬으면 다음과 같은 명령어를 입력 해준다.

git config --global commit.template <.git-commit-template 경로>

명령어를 이용해 git config --global commit.template /Users/{xxx}/git-template/.git-commit-template 를 터미널에 입력 해줬다.

git config에 여러 값이 있을때 에러 해결

파일경로를 여러 방면으로 수정해보려고 하다가 이런 에러가 나왔다.

값이 여러개 들어가 있어서 --add나 --replace all명령어를 이용해 commit.template를 바꿔주라는 말이다.
replace all명령어를 이용해 덮어씌워주는 쪽으로 해결 했다.

git config --global --replace all commit.template /Users/{xxx}/git-template/.git-commit-template