Skip to content

semantic-commit-messages.md

Latest commit

 

History

History
42 lines (31 loc) · 1.25 KB

semantic-commit-messages.md

File metadata and controls

42 lines (31 loc) · 1.25 KB

Semantic Commit Messages

The repository has adopted the following style of commits:
<type>(<scope>): <subject> | <type>: <subject>

If a commit contains Breaking Changes, use ! to show it:
<type>(<scope>)!: <subject> | <type>!: <subject>

Example

feat: add Cocoapods support
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Commit type.

Available commit types

  • feat: A new feature. Correlates with MINOR in SemVer
  • fix: A bug fix. Correlates with PATCH in SemVer
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts
  • docs: Documentation only changes
  • perf: A code change which improves performance
  • refactor: A code change that neither fixes
  • revert: A revert to previous commit
  • style: Changes that do not affect the meaning of the code (white-space, formatting, etc).

Changelog

Each release's Changelog is made up of commits that are either feat, fix or contain Breaking Changes, so you should be naming things carefully.

References