kazupon / Git Commit Message Convention
Programming Languages
git-commit-message-convention
Extend git commit message from angular style
Commit Message Format
All Commit Message Format MUST meet this Text Format:
[:<Emoji>: ][<Type>[(<Scope>)]: ]<Subject>
[<BLANK LINE>]
[<Message Body>]
[<BLANK LINE>]
[<Message Footer>]
Types
| Type | Description |
|---|---|
new |
for new feature implementing commit |
feature |
for new feature implementing commit (equal new) |
update |
for update commit |
bug |
for bug fix commit |
security |
for security issue fix commit |
performance |
for performance issue fix commit |
improvement |
for backwards-compatible enhancement commit |
breaking |
for backwards-incompatible enhancement commit |
deprecated |
for deprecated feature commit |
i18n |
for i18n (internationalization) commit |
a11y |
for a11y (accessibility) commit |
refactor |
for refactoring commit |
docs |
for documentation commit |
example |
for example code commit |
test |
for testing commit |
deps |
for dependencies upgrading or downgrading commit |
config |
for configuration commit |
build |
for packaging or bundling commit |
release |
for publishing commit |
wip |
for work in progress commit |
chore |
for other operations commit |
If the prefix is the below types, it will appear in the changelog.
-
new(feature) bugperformancesecurityimprovementdeprecatedbreaking
Scope
The scope could be anything specifying place or category of the commit change. For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, feature1, etc...
Subject
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Message Body
Just as in the Subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
Message Footer
The Message Footer should contain any information about Notes and also Message Footer should be recommended GitHub Issue ID Reference, Ex. Issue #27, Fixes #1, Closes #2, Resolves #3.
Notes should start with the word NOTE: with a space or two newlines. The rest of the commit message is then used for this.
Revert
If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit ., where the hash is the SHA of the commit being reverted.
Emojis
| Emoji | Raw Emoji Code | Type | Description |
|---|---|---|---|
| âī¸ | âī¸ |
new or feature
|
add new feature |
| đ | đ |
bug |
fix bug issue |
| đ | đ |
bug |
critical hotfix bug issue |
| đ | đ |
security |
fix security issue |
| đ | đ |
performance |
fix performance issue |
| âĄī¸ | âĄī¸ |
improvement |
update backwards-compatible feature |
| đĨ | :boom |
breaking |
update backwards-incompatible feature |
| â ī¸ | â ī¸ |
deprecated |
deprecate feature |
| đ | đ |
i18n |
update or fix internationalization |
| âŋī¸ | âŋī¸ |
a11y |
update or fix accessibility |
| đ¨ | đ¨ |
refactor |
remove linter/strict/deprecation warnings |
| đ | đ |
refactor |
refactoring or code layouting |
| â | â
|
test |
add tests, fix tests failur or CI building |
| đ | đ |
docs |
update documentation |
| Šī¸ | Šī¸ |
docs |
decide or change license |
| đ | đ |
example |
for example or demo codes |
| đ | đ |
update |
update UI/Cosmetic |
| đ | đ |
update |
update other |
| đ | đ |
update |
move or rename files, repository, ... |
| đ | đ |
update |
merge conflict resolution |
| â | â |
update |
add files, dependencies, ... |
| â | â |
update |
remove files, dependencies, ... |
| đ | đ |
update |
enable feature and something ... |
| âŦī¸ | âŦī¸ |
deps |
upgrade dependencies |
| âŦī¸ | âŦī¸ |
deps |
downgrade dependencies |
| đ | đ |
deps |
pin dependencies |
| đ§ | đ§ |
config |
update configuration |
| đĻ | đĻ |
build |
packaging or bundling or building |
| đŗ | đŗ |
build |
Dockerfile |
| đŖ | đŖ |
release |
initial commit |
| đ | đ |
release |
release major version |
| đ | đ |
release |
release minor version |
| ⨠| ⨠|
release |
release patch version |
| đ | đ |
release |
deploy to production enviroment |
| đ | đ |
release |
tagged with version label |
| đ | đ |
revert |
revert commiting |
| đ§ | đ§ |
wip |
WIP commiting |
Ask to Be Creative!
Examples
new:
âī¸ new(graphite): add 'graphiteWidth' option
bug fix:
đ fix(graphite): stop graphite breaking when width < 0.1
Closes #28
improve performance:
đ performance(graphite): remove graphiteWidth option
The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
revert:
đ revert: new: add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Support tools
conventional-changelog
You can use with conventional-changelog-cli and conventional-github-releaser.
e.g. conventional-changelog-cli:
$ npm i --save-dev git://github.com/kazupon/git-commit-message-convention.git
$ conventional-changelog -i CHANGELOG.md -s -n ./node_modules/git-commit-message-convention/convention.js -r 0
e.g. conventional-github-releaser:
$ conventional-github-releaser -n ./node_modules/git-commit-message-convention/convention.js -r 0
TODO
- [x] support conventional commit tools (e.g. conventional-changelog)
- [ ] lint
- [ ] cli
- [ ] create a conventional commit tools with
golang