커밋 메시지 작성 방식

커밋 메시지 예시

일반적으로 아래의 방식대로

커밋 메시지를 작성한다

Feat: A 기능 추가

B API 개발
C 모드 변경

Resolves: #123
Ref: #456
Related to: #48, #45

 

커밋 Type

대표적인 커밋 type은 아래와 같다

Feat		새로운 기능을 추가
Fix		버그 수정
Design		CSS 등 사용자 UI 디자인 변경
Style		코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor	프로덕션 코드 리팩토링
Comment		필요한 주석 추가 및 변경
Docs		문서 수정
Test		테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음
Chore		빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음
Rename		파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove		파일을 삭제하는 작업만 수행한 경우

!BREAKING CHANGE	커다란 API 변경의 경우
!HOTFIX			급하게 치명적인 버그를 고쳐야하는 경우

 

커밋 작성 유의점

1) 간결 명확해야 한다

2) How가 아닌 What, Why 위주로 기술한다

 

 

참고문서:

// 커밋 컨벤션

https://velog.io/@archivvonjang/Git-Commit-Message-Convention

 

// 영어 커밋을 위한 영단어

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

 

// 커밋 줄바꿈 방법

https://univdev.page/posts/visual_studio_code%EC%97%90%EC%84%9C_%EA%B9%83_%EB%A9%94%EC%8B%9C%EC%A7%80_%EC%83%81%EC%84%B8%ED%95%98%EA%B2%8C_%EB%82%A8%EA%B8%B0%EA%B8%B0/