Commit Message를 작성하는 법
유형들이 복합적으로 포함되어 있을 경우, 되도록 커밋을 분리한다. 분리가 어려운 경우 위 순서상 상위 항목의 유형으로 작성한다. (eg. 기능과 테스트가 모두 포함된 경우 기능으로 작성)
- feat: 기능 추가, 삭제, 변경(or ✨ emoji) - 제품 코드 수정 발생
- fix: 버그 수정(or 🚑 emoji) - 제품 코드 수정 발생
- docs: 문서 추가, 삭제, 변경(or 📚 emoji) - 코드 수정 없음
- style: 코드 형식, 정렬, 주석 등의 변경, eg; 세미콜론 추가(or 🎨 emoji) - 제품 코드 수정 발생, 하지만 동작에 영향을 주는 변경은 없음
- refactor: 코드 리펙토링, eg. renaming a variable(or 🚜 emoji) - 제품코드 수정 발생
- test: 테스트 코드 추가, 삭제, 변경 등(or 🔬 emoji) - 제품 코드 수정 없음. 테스트 코드에 관련된 모든 변경에 해당
- etc: 위에 해당하지 않는 모든 변경, eg. 빌드 스크립트 수정, 패키지 배포 설정 변경 - 코드 수정 없음
커밋 메시지 작성시 사용할만한 Emoji
Emoji | Raw Emoji Code | Description | ㅤ |
🎨 | :art: | 코드의 형식 / 구조를 개선 할 때 | ㅤ |
📰 | :newspaper: | 새 파일을 만들 때 | ㅤ |
📝 | :pencil: | 사소한 코드 또는 언어를 변경할 때 | ㅤ |
🐎 | :racehorse: | 성능을 향상시킬 때 | ㅤ |
📚 | :books: | 문서를 쓸 때 | ㅤ |
🐛 | :bug: | 버그 reporting할 때, @FIXME주석 태그 삽입 | ㅤ |
🚑 | :ambulance: | 버그를 고칠 때 | ㅤ |
🐧 | :penguin: | 리눅스에서 무언가를 고칠 때 | ㅤ |
🍎 | :apple: | Mac OS에서 무언가를 고칠 때 | ㅤ |
🏁 | :checkered_flag: | Windows에서 무언가를 고칠 때 | ㅤ |
🔥 | :fire: | 코드 또는 파일 제거할 때 , @CHANGED주석 태그와 함께 | ㅤ |
🚜 | :tractor: | 파일 구조를 변경할 때 . 🎨과 함께 사용 | ㅤ |
🔨 | :hammer: | 코드를 리팩토링 할 때 | ㅤ |
☔️ | :umbrella: | 테스트를 추가 할 때 | ㅤ |
🔬 | :microscope: | 코드 범위를 추가 할 때 | ㅤ |
💚 | :green_heart: | CI 빌드를 고칠 때 | ㅤ |
🔒 | :lock: | 보안을 다룰 때 | ㅤ |
⬆️ | :arrow_up: | 종속성을 업그레이드 할 때 | ㅤ |
⬇️ | :arrow_down: | 종속성을 다운 그레이드 할 때 | ㅤ |
⏩ | :fast_forward: | 이전 버전 / 지점에서 기능을 전달할 때 | ㅤ |
⏪ | :rewind: | 최신 버전 / 지점에서 기능을 백 포트 할 때 | ㅤ |
👕 | :shirt: | linter / strict / deprecation 경고를 제거 할 때 | ㅤ |
💄 | :lipstick: | UI / style 개선시 | ㅤ |
♿️ | :wheelchair: | 접근성을 향상시킬 때 | ㅤ |
🚧 | :construction: | WIP (진행중인 작업)에 커밋, @REVIEW주석 태그와 함께 사용 | ㅤ |
💎 | :gem: | New Release | ㅤ |
🔖 | :bookmark: | 버전 태그 | ㅤ |
🎉 | :tada: | Initial Commit | ㅤ |
🔈 | :speaker: | 로깅을 추가 할 때 | ㅤ |
🔇 | :mute: | 로깅을 줄일 때 | ㅤ |
✨ | :sparkles: | 새로운 기능을 소개 할 때 | ㅤ |
⚡️ | :zap: | 도입 할 때 이전 버전과 호환되지 않는 특징, @CHANGED주석 태그 사용 | ㅤ |
💡 | :bulb: | 새로운 아이디어, @IDEA주석 태그 | ㅤ |
🚀 | :rocket: | 배포 / 개발 작업 과 관련된 모든 것 | ㅤ |
🐘 | :elephant: | PostgreSQL 데이터베이스 별 (마이그레이션, 스크립트, 확장 등) | ㅤ |
🐬 | :dolphin: | MySQL 데이터베이스 특정 (마이그레이션, 스크립트, 확장 등) | ㅤ |
🍃 | :leaves: | MongoDB 데이터베이스 특정 (마이그레이션, 스크립트, 확장 등) | ㅤ |
🏦 | :bank: | 일반 데이터베이스 별 (마이그레이션, 스크립트, 확장명 등) | ㅤ |
🐳 | :whale: | 도커 구성 | ㅤ |
🤝 | :handshake: | 파일을 병합 할 때 | ㅤ |