Conventional Commits
Spec: https://www.conventionalcommits.org/en/v1.0.0/
Format
code
<type>[optional scope]: <description> [optional body] [optional footer(s)]
Types
- •
feat— new feature (SemVer MINOR) - •
fix— bug fix (SemVer PATCH) - •Also permitted:
build,chore,ci,docs,style,refactor,perf,test
Rules
- •Scope is optional, in parentheses:
feat(parser): - •Description MUST immediately follow the colon and space
- •Body is optional, separated by one blank line from description
- •Footers are optional, separated by one blank line from body
- •Breaking changes: add
!before colon OR useBREAKING CHANGE:footer (SemVer MAJOR) - •
BREAKING CHANGEMUST be uppercase - •Footer tokens use hyphens for spaces (e.g.,
Acked-by)