git commit message 규칙을 정해야할 시기가 왔다고 생각해 정리를 시작한다. 현재, first commit, second commit 등등 이런 식으로 빈 내용으로 채우고 있다. 전 회사에서 만든게 있지만, 그걸 업그레이드 해보는게 어떨까 생각이 들어 새롭게 정해보았다.
Udacity Git Commit의 가이드를 기반으로 규칙을 만들었다.
commit message의 형태는 다음과 같이 구성할 예정이다.
(형식)
type: Subject
body
footer
-------------------------------------------------------------
(예시)
fix: "테이블 참조 에러 수정"
프로젝트에서 참조하는 테이블 형식이 상이해서 발생한 오류
fixes: #45
related to: #34, #23
모든 단어는 소문자로 이루어져 있어야 함
feat
: 새로운 기능 추가fix
: 버그 수정docs
: 문서 수정style
: (코드 생산성이 없음) 형식 변경, 세미 콜론을 빼먹은 경우 등 형식 관련해서 수정하는 경우 refactor
: 리펙토리로 인한 수정test
: (코드 생산성이 없음) 테스트 및 리펙토리로 인한 수정chore
: (코드 생산성이 없음) 작업 빌드 업데이트, 구성 파일 패키지 및 위 경우에 속하지 않는 경우feat(database) -> 데이터베이스 관련 기능 추가
feat(api) -> api 관련 기능 추가
feat(script) -> script 관련 기능 추가
feat(security) -> 보안 관련 기능 추가
추후 추가할 예정...
issue tracker id를 할용하여 작성
fixes
: issue 수정resolves
: issue 해결ref
: 참고할 issue 참조Related to
: 관련된 issue 참조fixes: #45
related to: #34, #23