[Git] Good Commit Message
commit message 작성
이전의 커밋 메시지
혼자 git을 사용할때는 commit message를 내가 보기편한 방식으로 작명하면되었다.
하지만, 코드의 내용이 많아지고 복잡해 질수록 메시지를 이해하는데 어려움을 격게 된다.
그러므로 협업할때 미리 commit message을 정해두면 이후 가독성도 올라가고, 유지보수 할때도 많은 도움이 될 것이다.
아래는 많은 사람들이 권장하는 Commit Message의 규칙들 이다.
좋은 Commit Message의 7가지 규칙
- 제목과 본문을 한 줄 띄워 분리
- 제목은 영문 기준 50자 이내
- 제목의 첫글자는 대문자로
- 제목에 “.” 금지
- 제목은 명령어로
- 영문 72자 마다 줄바꾸기
- 본문은 어떻게 보다 무엇을, 왜 에 맞춰 작성
Commit Message 제목 짓기
형식은 “태그: 제목” 입니다.
태그 이름 | 설명 |
---|---|
Feat | 새로운기능을 추가할 경우 |
Fix | 버그를 고친경우 |
Design | CSS등 사용자 UI 디자인 변경 |
!BREAKING CHANGE | 커다란API 변경 |
!HOTFIX | 급하게 치명적인 버그를 초쳐야하는 경우 |
Style | 코드 포맷 변경, 세미콜론 누락 등 코드 수정이 없는 경우 |
Refactor | 프로덕션 코드 리팩토링 |
Comment | 필요한 주석 추가 및 변경 |
Docs | 문서를 수정한 경우 |
Test | 테스트 추가, 테스트 리팩토링(프로덕션 코드변경X) |
Chore | 빌드 테스트 업데이트, 패키지 메니저를 설정하는 경우(프로덕션 코드 변경X) |
Rename | 파일 혹은 폴더명을 수정하거나 옮기는 작업만 있는 경우 |
Remove | 파일을 삭제하는 작업만 수행한 경우 |
이후에도 다시 볼 수도 있을 것 같다는 내용들만 간단히 가져왔습니다.
추가적인 설명을 보고 싶은 분들은 아래 링크를 참고서 하시고 길 바랍니다.
< Refer to >
How to Write a Git Commit Message
협업을 위한 git 커밋컨벤션 설정하기
Leave a comment