-
Notifications
You must be signed in to change notification settings - Fork 15
Git Commit Writing Guide
John Kouraklis edited this page Jan 25, 2019
·
3 revisions
Git commit messages follow the general guidelines widely available (atomic commits, imperative writing style, etc.)
In addition, commits should use the following semantics:
| Commit | Equivalent Git Commit Element | Commit Message Example |
|---|---|---|
| + | Add | + methods to calculate ratios |
| - | Remove | - redundant calls to API |
| * | Update | * project files |
| \*/ | Clean Code | \*/ policy manager files |
| Dolphins | Used to describe that the commit has some necessary changes but nothing relevant (eg. a blank line was added, the newly saved file has rearranged elements in the settings file, etc.) Use this when the modified files in the commit have just "indescribable" changes |
