git commit 템플릿 사용하여 commit message convention 준수하기
지금까지 깃허브를 사용하면서 커밋 메세지 작성법을 크게 신경쓰지 않았던 것 같습니다.
하지만 커밋의 내용이 무엇인지, 그리고 어떤 것을 의도하였는지 명확하게 보여줄 수 있도록 하는 것이 중요함을 알게 되었고 커밋 메세지 컨벤션에 대해 조사하게 되었습니다.
자세한 규칙은 아래 사이트를 참조하시면 됩니다!
Conventional Commits (https://www.conventionalcommits.org/en/v1.0.0/)
위 사이트에서는 커밋 메세지를 구성하는 방법을 아래와 같이 요약하고 있습니다.
1
2
3
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
- 제목은 어떤 것을 했는지 명확한 단어가 들어가야 하고, 너무 길게 작성하지 않는다.
- 내용은 선택사항이나 자세한 커밋 메세지를 작성하고자 할 때, 제목에 이어 부가적인 설명을 붙인다. 이 커밋을 한 이유와 변경 내용 등을 작성한다.
- 푸터는 선택사항이고 관련 이슈 번호를 참조시킬 때 주로 사용한다.
type 에는 다음과 같은 단어가 들어가면 좋습니다.
- feature : 새로운 기능 추가
- fix : 버그 수정
- docs : 문서 수정
- test : 테스트 코드 추가
- refactor : 코드 리팩토링
- style : 코드 의미에 영향을 주지 않는 변경사항
- chore : 빌드 부분 혹은 패키지 매니저 수정사항
git commit -m 으로 커밋 제목만 짧게 작성하기보다는, 추가적인 커밋 설명을 덧붙이는 습관을 들이면 좋을 것 같습니다.
커밋 제목 밑에 추가 부연설명을 달기 위해서는, 제목에 엔터(줄바꿈) 2번 한 이후 설명을 적으면 됩니다.
1
2
3
git commit -m "커밋 제목
부가 설명"
만약 커밋에 좀 더 설명이 필요하다면 제목만 짧게 적기보다, 위와 같이 설명도 같이 달아주면 좋습니다.
혹은 아래와 같이 commit을 할 때 자동으로 템플릿이 뜨게끔 할 수도 있습니다.(커밋 템플릿 파일)
커밋 템플릿 파일 만들기(commit template file)
커밋 메세지 템플릿을 적용할 git 프로젝트에 진입한 다음,
.gitmessage.txt파일을 생성합니다.이제 그 파일 내용을 아래와 같이 수정합니다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# <타입> : <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
# 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성
################
# 본문(추가 설명)을 아랫줄에 작성
################
# 꼬릿말(footer)을 아랫줄에 작성 (관련된 이슈 번호 등 추가)
################
# feature : 새로운 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refactor : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
################
# 으로 된 줄은 모두 주석처리된 곳이며, 비어 있는 첫 번째~세 번째 줄에 각각 작성하면 그것이 커밋 제목, 본문, 꼬릿말이 되는 것입니다. 위와 같이 파일 내용을 수정하고 저장합니다.
- 다음 아래 명령어를 입력합니다.
<.gitmessage.txt 경로>부분에는 위에서 생성한 파일의 경로를 입력하면 됩니다. (< >제외)
1
git config --global commit.template <.gitmessage.txt 경로>
이제부터 git commit 입력 시, 위에서 지정한 템플릿 파일이 자동으로 뜨게 됩니다. 거기에서 커밋 제목, 본문, 꼬릿말 등을 추가하면 됩니다.
이 때 터미널 환경에서 git commit을 입력하면 vi 에디터 환경으로 나올 것입니다. 작성할 때에는 키보드 i 키를 누르면 되며, 작성 완료하고 저장하려면 esc 키를 누른 다음 :wq! 를 입력하고 엔터를 누르시면 됩니다.