Skip to content

Conventional Commits

Conventional Commits
conventionalcommits.org/en/v1.0.0

Quick examples

feat: new feature
fix(scope): bug in scope
feat!: breaking change
feat(scope)!: breaking change in scope
chore(deps): updated dependencies

Commit Types

TypeDescription
buildChanges that affect the build system or external dependencies (example scopes: Docker, npm, CDK)
ciChanges to CI configuration files and scripts (example scopes: Github, CodePipeline)
choreChanges which doesn't change source code or tests e.g. changes to the build process, auxiliary tools, libraries
docsDocumentation only changes
featA new feature
fixA bug fix
perfA code change that improves performance
refactorA code change that neither fixes a bug nor adds a feature
revertRevert something
styleChanges that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
testAdding missing tests or correcting existing tests
wipWork-in-progress (typically for feat/ or fix/ branches)