- Update
- Fix
- Refactor
- Chore
- Merge
- (WIP)
Removed:
Feature / Release– use Merge insteadDocs— use Chore insteadRevert– use Fix insteadTest– use Update instead
Update: A generic update that involves changes and does not fit any other category.
Fix: Code fixes and bug fixes
Refactor: Refactoring changes that do not change functionality per se.
Chore: “ Replaces Style | Format: Includes Cleanup, whitespace, formatting, old dependencies etc. Should not change functionality.
Merge: Branch merges. Includes a list of merged commits. For a feature branch merges Feat/Fix or others might be more apropriate.
WIP: Work in Progress – Ideally we should not use this. Realistically you will need to make incomplete commits at some point. Use this to warn about the incomplete state your commit causes.
##Other Guidelines
- camunda.org Commit Message Conventions (good stuff!)
- angular.js Commit Guidelines (very similar)
- Notably also Tim Pope's "A Note About Git Commit Messages". Personally I do not agree with the 50 chars summary, yet with the rest I can wholeheartedly agree. Especially the part about the imperative. The commit message should convey what it does (or what it intends to do).
Capitalized, short (50 chars or less) summary
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body. The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.
Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
or "Fixes bug." This convention matches up with commit messages generated
by commands like git merge and git revert.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, followed by a
single space, with blank lines in between, but conventions vary here
- Use a hanging indent