[Git] Commit Message Rules

Intro

commit message를 잘 쓰기 위해서 노력해야하는 이유는 잘 쓰인 커밋 메세지가 더 유익하다는 점을 많은 프로그래머들이 공감한다고 한다.
대표적인 장점으로 3가지가 있다.

1. 커밋 로그 가독성
2. 더 나은 협엽과 리뷰 프로세스
3. 더 쉬운 코드 유지보수

Commit Msg

• feat : 새로운 기능
• fix : 버그 수정
• docs : documentation 변경
• style : 코드 의미에 영향을 주지 않는 변경사항 (fomatting, colons etc)
• refactor : 버그 수정, 기능 추가가 아닌 코드 변경, 리팩토링
• test : 누락된 테스트 추가 또는 기존 테스트 수정
• chore : 패키지 매니저 설정 (코드 수정 없이 설정 변경)

하지만 팀에 소속되어 있다면 팀에서 정한 commit message를 따르는게 원칙이다🙄

Commit Msg - My Team

• Add : 코드나 테스트, 예제, 문서 등의 추가가 있을 때 사용
• Fix : 보통 올바르지 않은 동작을 고친 경우에 사용
• Remove : 코드의 삭제가 있을 때 사용
• Use : 특별히 무언가를 사용해 구현을 하는 경우
• Update : 개정이나 버전 업데이트가 있을 때 사용. Fix와는 달리 Update는 잘못된 것을 바로잡는 것이 아니라는 점에 주의해야 한다. 원래도 정상적으로 동작하고 있었지만, 수정, 추가, 보완을 한다는 개념이다. 코드보다는 주로 문서나 리소스, 라이브러리등에 사용
• Refactor : 전면 수정이 있을 때 사용한다. 코드 리팩토링 (함수 변수명 네이밍, 불필요한 코드 제거 등)

개인 github에는 첫번째 commit msg를 써보고 팀에서 팀이 정한 msg 규칙을 따르면서 다양하게 써볼 예정이😏🥕

참고

http://karma-runner.github.io/0.10/dev/git-commit-msg.html
https://djkeh.github.io/articles/How-to-write-a-git-commit-message-kor/
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html