Git 커밋 메시지 작성할 때 참고하면 좋을 글 (Git commit message convention)

Git 커밋 메시지는 중요하다.

혼자 작업할 때나 팀프로젝트를 할 때 커밋 메시지로 작업 히스토리를 확인하기 쉽기 때문이다.

팀프로젝트나 회사에서 일할 땐 팀에서 정한 규칙대로 따라가면 되지만, 혼자 할 때는 혼자만의 규칙으로 작업하려고 한다.

공개 프로젝트일 때는 다른 사람들도 볼 수 있기 때문에 혼자만 알아볼 수 있는 메시지 보단 모두들 알아볼 수 있는 규칙으로 작성하는 게 좋다고 생각한다. (사실 혼자만 볼 때도 알아보기 쉬운 규칙이어야 나중에 작업한지 오래되어 까먹었을 때 봐도 이해하기 쉬울 것 같다)

이 글은 개인적으로 괜찮아보였던 커밋 메시지 규칙들 링크를 저장해두기 위함이다.

 

Conventional Commits

https://www.conventionalcommits.org/en/v1.0.0/

Conventional Commits

Karama Runner Git Commit Msg

http://karma-runner.github.io/2.0/dev/git-commit-msg.html

Karma - Git Commit Msg

기본적으로 type: description 구조로 남긴다.

본인은 간략하게 아래 type들만 사용해봤다.

type:

1. feat: 새 기능 추가
2. fix: 버그 수정
3. style: 스타일 작업
4. docs: 문서 작업 (ex. README.md)
5. refactor: 리팩토링 작업 (ex. 변수명 수정 등의 작업 포함)
6. chore: 위의 타입 리스트에 포함되지 않는 기타 작업들

 

좋은 git commit 메시지를 위한 영어 사전

https://blog.ull.im/engineering/2019/03/10/logs-on-git.html

ull.im

영어로 커밋 메시지를 작성할 때 참고하기 좋은 글이다.

저 위의 type 없이 이 글만 참고해서 작성해도 좋은 것 같다. 혹은 이 글을 참고해서 type의 description을 작성해도 좋다.

개인적으로는 type: description 구조가 깔끔하고 보기 좋았다.