(git) Commit Template으로 commit 시간 단축하기

snippet: git
2023.07.06
3분
댓글

VSCode에서 commit하기

  • 일일이 feat:... 의 커밋 규칙을 입력하기 귀찮은 분들 혹은 오타로 인해 정해놓은 커밋 규칙을 지키지 못해서 불편함을 겪었던 분들이라면, 이번 과정에 주목해주시기 바랍니다!
  • 터미널에서 커밋 메세지를 입력하지 않아도 vscode에서 텍스트 파일을 수정하는 방식으로 커밋할 수 있도록 설정해보겠습니다.

1. git commit 입력 시에 vscode에서 커밋 파일이 열리도록 설정하기

  • 혹시 code 명령어를 찾을 수 없다는 에러가 보인다면 해당 포스트를 통해 설치해주세요!
git config --global core.editor "code --wait"

2. git message 템플릿 파일 설정하기

git config --global commit.template .gitmessage.txt

3. .gitmessage.txt 파일을 루트 폴더에 만들기

형식은 자유롭게 수정하셔도 좋습니다.

# <타입> : <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
# 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성

################
# [feat] : 새로운 기능 추가
# [fix] : 버그 수정
# [docs] : 문서 수정
# [test] : 테스트 코드 추가
# [refactor] : 코드 리팩토링
# [style] : 코드 의미에 영향을 주지 않는 변경사항
# [chore] : 빌드 부분 혹은 패키지 매니저 수정사항
################

230706-182532

4. git commit을 입력

터미널에서 git commit을 입력하면 vscode에서 .gitmessage.txt 파일이 열립니다.
230706-182303

5. 커밋하기

필요한 명령어 부분의 주석을 지우고 내용을 입력한뒤 txt 파일을 닫으면 (X 버튼 클릭) 커밋이 완료됩니다! 👏
230706-182223

6. 커밋 확인

git log를 보면 커밋이 잘 된 것을 확인할 수 있습니다.

개인적으로 협업할 때 적용 후 가장 편리하다고 느꼈던 기능이었습니다.
커밋에서의 실수도 줄일 수 있고 커밋을 여러번 할 경우 시간을 단축할 수 있어서
(특히나 깃모지를 사용하신다면 이모지 찾는 시간을 획기적으로 줄일 수 있습니다!)

많은 분들이 사용해보셨으면 좋겠습니다 😄

Git Hist
Git Commit
Vscode Commit

프로필 사진
Suhyeon Park
Frontend Engineer