Emoji | Emoji String | Meaning | Subject of Commit | Counterpart in Conventional Commits |
---|---|---|---|---|
πΆ | :notes: |
improve behavior or API | Major update (*1) | BREAKING CHANGE: |
β¨ | :sparkles: |
implement a new function or the first commit | Minor update (*1) | feat: |
π | :bug: |
fix a bug | Patch update (*1) | fix: |
π΄ | :horse: |
improve performance | Non-functional feature (*2) | perf: |
π | :lock: |
improve security | Non-functional feature (*2) | feat: (?) |
π | :mag: |
about test codes | Maintenability | test: |
π | :memo: |
about documentation (*3) | Maintenability | docs: |
π | :green_heart: |
refactor | Maintenability | refactor: or style: |
β¬οΈ | :arrow_up: |
update dependencies (includes code changes for it) | Maintenability | chore: |
π§ | :wrench: |
configure for development or CI tools | Maintenability | chore: |
π | :bookmark: |
about a release | Release | chore: |
π | :rocket: |
about a deploy | Deploy | chore: |
π§ | :construction: |
WIP (work in progress) | Temporary | none |
(*1) By the semantic versioning
(*2) These may belong to minor update.
(*3) Including comments in source code. Their role is just a document,
and they may be used by document generators.
Because I want to record commit messages, descriptions of reason for change.