A quicktip about writing good commit messages. It’s inspired by major open sources projects, like AngularJS.
Commit Message Conventions
<type>(<scope>): <subject> (#<task_id>) <BLANK LINE> <body> <BLANK LINE>
- title (less than 50 chars)
- type: ‘feat’, ‘doc’, ‘fix’, ‘refactor’, ‘build’
- scope: your project task’s scope (one word)
- subject: the work done
- id: your task or issue or ticket unique ID
- body (optionnal)
- details for big tasks
Examples
feat(menu): color, font (#102)
doc(menu): get started (#103)
fix(menu): color change bug (#399)
feat(account): font (#104)
doc(account): get started (#104)
refactor: common font for menu, account (#652)
fix: remove deprecated fonts (#901) Removed: * Arial.ttf * Comic.ttf
Source
https://github.com/DamienFremont/blog/tree/master/20170606-git-commit-message-conventions/
References
https://github.com/angular/material2/blob/master/CONTRIBUTING.md
