conventional-commit-types

August 24, 2017 ยท View on GitHub

[DEPRECATED] - Use conventional-changelog-metahub instead

conventional-commit-types

List of conventional commit types, extending conventional-commit-types, with emojis and additionnal commit types (aliases).

npm npm Greenkeeper badge license semantic-release Commitizen friendly

Travis Codecov

Used by cz-conventional-commit.

Commit types originally from:

Commit types

Commit TypeTitleDescriptionEmoji
featFeaturesA new featureโœจ
fixBug FixesA bug Fix๐Ÿ›
docsDocumentationDocumentation only changes๐Ÿ“š
styleStylesChanges that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)๐Ÿ’Ž
refactorCode RefactoringA code change that neither fixes a bug nor adds a feature๐Ÿ“ฆ
perfPerformance ImprovementsA code change that improves performance๐Ÿš€
testTestsAdding missing tests or correcting existing tests๐Ÿšจ
buildBuildsChanges that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)๐Ÿ› 
ciContinuous IntegrationsChanges to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)โš™๏ธ
choreChoresOther changes that don't modify src or test filesโ™ป๏ธ
revertRevertsReverts a previous commit๐Ÿ—‘

Commit aliases

Aliases allow to have additionnal commit types (in a tool like commitizen for example) that can be formatted to follow AngularJS Commit Message Conventions.

For example the commitizen CLI can present the choice initial and the final commit message will be 'feat: Initial commit ๐ŸŽ‰'

Commit TypeMaps toTitleDescriptionEmoji
initialfeatInitialInitial commit๐ŸŽ‰
dependenciesfixDependenciesUpdate dependenciesโซ
peerDependenciesfixPeer dependenciesUpdate peer dependenciesโฌ†๏ธ
devDependencieschoreDev dependenciesUpdate development dependencies๐Ÿ”ผ
metadatafixMetadataUpdate metadata (package.json)๐Ÿ“ฆ