최근에서야 깃 컨벤션을 알게되어 적용시켜 커밋메세지를 작성하고있다.
매번 글찾아서 보면서 적기 불편해서 따로 정리를 하려한다.
Commit Message 구조는 제목, 본문, 꼬리말 세가지 파트로 나누고,
빈줄로 구분한다.
type: subject
body ( 선택 사항 )
footer ( 선택 사항 )
타입은 태그와 제목으로 구성,
태그는 영어로 쓰고, 첫 문자는 대문자
feat : 새로운 기능 추가
| 태그 이름 | 설명 |
|---|---|
| Feat | 새로운 기능을 추가할 경우 |
| Fix | 버그를 고친 경우 |
| !BREAKING CHANGE | 커다란 API 변경의 경우 |
| !HOTFIX | 급하게 치명적인 버그를 고쳐야하는 경우 |
| Style | 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우 |
| Refactor | 프로덕션 코드 리팩토링 |
| Comment | 문서를 수정한 경우 |
| Test | 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X) |
| Rename | 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우 |
| Remove | 파일을 삭제하는 작업만 수행한 경우 |
제목은 간결하고 요점만 50글자 이내로 작성하고, 마침표 및 특수기호 사용 X
영문으로 표기하는 경우 동사(원형)를 가장 앞에두고 첫글자는 대문자로 표기
과거 시제 사용 X
Added -> Add
Fixed -> Fix
본문은 한 줄 당 72자 내로 작성
본문 내용은 양에 구애받지 않고 최대한 상세히 작성
본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 설명
optional이고 이슈 트래커 ID를 작성유형: #이슈 번호 형식으로 사용쉼표(,)로 구분| Emoji | Description |
|---|---|
| 🎨 | 코드의 형식 / 구조를 개선 할 때 |
| 📰 | 새 파일을 만들 때 |
| 📝 | 사소한 코드 또는 언어를 변경할 때 |
| 🐎 | 성능을 향상시킬 때 |
| 📚 | 문서를 쓸 때 |
| 🐛 | 버그 reporting할 때, @FIXME 주석 태그 삽입 |
| 🚑 | 버그를 고칠 때 |
| 🔥 | 코드 또는 파일 제거할 때 , @CHANGED주석 태그와 함께 |
| 🚜 | 파일 구조를 변경할 때 . 🎨과 함께 사용 |
| 🔨 | 코드를 리팩토링 할 때 |
| 💄 | UI / style 개선시 |
| ♿️ | 접근성을 향상시킬 때 |
| 🚧 | WIP (진행중인 작업)에 커밋, @REVIEW주석 태그와 함께 사용 |
| 💎 | New Release |
| 🔖 | 버전 태그 |
| ✨ | 새로운 기능을 소개 할 때 |
| ⚡️ | 도입 할 때 이전 버전과 호환되지 않는 특징, @CHANGED주석 태그 사용 |
| 💡 | 새로운 아이디어, @IDEA주석 태그 |
| 🚀 | 배포 / 개발 작업 과 관련된 모든 것 |
깃 컨벤션을 알기 전 커밋 메시지와
깃 컨벤션을 어느정도 따라하며 작성한 커밋 메시지의
차이가 정말 큰거같다.
