커밋 메시지 컨벤션은 프로젝트에서 일관된 커밋 메시지 형식을 사용하도록 정하는 규칙입니다. 이를 도입하면 여러 가지 이점이 있어 협업과 코드 관리가 훨씬 효율적입니다.
GitHub에서 프로젝트의 커밋 메시지 형식을 일관되게 유지하려면 다음 방법을 통해 사용할 수 있습니다.
1. Commit Message Convention 정하기
프로젝트 팀에서 사용할 커밋 메시지 규칙을 정해야 합니다. 예를 들어, 다음과 같은 규칙을 사용할 수 있습니다:
- [type] subject 형식:
- feat: 새로운 기능 추가
- fix: 버그 수정
- docs: 문서 관련 작업
- style: 코드 스타일 변경 (동작에는 영향 없음)
- refactor: 리팩토링
- test: 테스트 추가 또는 수정
- chore: 기타 변경 사항 (빌드 설정, 도구 추가 등)
2. 템플릿 파일 생성
아래 명령어를 실행해 .gitmessage.txt 파일을 생성
touch .gitmessage.txt
해당 파일을 아래와 같이 원하는 커밋 메세지 형식으로 설정합니다.
# 커밋 메시지 템플릿
# [type]: 설명 (동사를 사용하여 간결하게 작성)
#
# 예: feat: 로그인 페이지 디자인 개선
#
# type 종류:
# feat: 새로운 기능
# fix: 버그 수정
# docs: 문서 관련 작업
# style: 코드 스타일 변경
# refactor: 코드 리팩토링
#로 시작하는 부분은 주석으로 커밋에 반영되지 않는다.
아래 커맨드를 통해 커밋 메세지로 등록
git config --global commit.template ~/.gitmessage.txt
이후 git commit을 실행하면 템플릿 내용이 기본으로 표시됩니다.