올바른 커밋 메시지

우리는 commit을 할때, message를 함께 작성할 수 있다.

커밋메시지를 통해 추후 GRAPH를 추적하거나 기존의 소스에서 수정했던, 혹은 구현했던 부분을 다시 찾아보거나, 다른 사람들이 보고 코멘트를 남길때, 명확한 커밋 메시지는 많은 도움이 된다.

좋은 커밋메시지를 위한 몇가지 좋은 규칙들이 있어 습관을 들이기 위해 기록해본다.

1. 좋은 커밋 메시지의 7가지 규칙

• 제목과 본문을 한줄 띄워 분리하기

• 제목은 영문 기준 50자 이내로

• 제목 첫 글자를 대문자로

• 제목 끝에 . 금지

• 제목은 명령조로

• 제목(이나 본문)에 이슈 번호 붙이기

• 본문은 영문 기준 72자마다 줄 바꾸기

• 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

2. 커밋 메시지 구조

type: commit message
   
    - edited readme.me
    - update XXXXXX

3. 타입

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 수정
style : 코드 formatting, 세미콜론(;) 누락, 코드 변경이 없는 경우
refactor : 코드 리팩터링
test : 테스트 코드, 리팩터링 테스트 코드 추가(프로덕션 코드 변경 X)
chore : 빌드 업무 수정, 패키지 매니저 수정(프로덕션 코드 변경 X)
design : CSS 등 사용자 UI 디자인 변경
comment : 필요한 주석 추가 및 변경
rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
remove : 파일을 삭제하는 작업만 수행한 경우
!BREAKING CHANGE : 커다란 API 변경의 경우
!HOTFIX : 급하게 치명적인 버그를 고쳐야 하는 경우