-
Notifications
You must be signed in to change notification settings - Fork 30
Conventional Commits
Cheton Wu edited this page Jan 21, 2020
·
6 revisions
<type>(<scope>): <subject>
<scope> is optional
feat: add hat wobble
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
| Type | Title | Description | Emoji | Release |
|---|---|---|---|---|
feat |
Feature | New feature for the user, not a new feature for build script | ✨ | minor |
fix |
Bug Fix | Bug fix for the user, not a fix to a build script | 🐛 | patch |
docs |
Documentation | Changes to documentation | 📚 |
patch if scope is readme
|
style |
Style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | 💎 | - |
refactor |
Code Refactoring | A code change that neither fixes a bug nor adds a feature | 📦 | - |
perf |
Performance Improvement | A code change that improves performance | 🚀 | patch |
test |
Test | Adding missing tests or correcting existing tests | 🚨 | - |
build |
Build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | 🛠 | patch |
ci |
Continuous Integration | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ⚙️ | - |
chore |
Chore | Other changes that don't modify src or test files | ♻️ | - |
revert |
Revert | Reverts a previous commit | 🗑 | - |