Skip to content

Conventional Commits

Cheton Wu edited this page Jan 21, 2020 · 6 revisions

Semantic Commit Message Format

<type>(<scope>): <subject> <scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More examples:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Commit Title Description Emoji Release Changelog
feat Features New feature for the user, not a new feature for build script minor true
fix Bug Fixes Bug fix for the user, not a fix to a build script 🐛 patch true
docs Documentation Changes to documentation 📚 patch if scope is readme true
style Styles Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) 💎 - true
refactor Code refactoring A code change that neither fixes a bug nor adds a feature 📦 - true
perf Performance Improvements A code change that improves performance 🚀 patch true
test Tests Adding missing tests or correcting existing tests 🚨 - true
build Builds Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) 🛠 patch true
ci Continuous Integrations Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) ⚙️ - true
chore Chores Other changes that don't modify src or test files ♻️ - true
revert Reverts Reverts a previous commit 🗑 - true

Clone this wiki locally