不談使用git message模板的原因或者歷史,網上有一堆。相信針對看到這文章的人都知道,目前自己的版本管理中,追溯提交日誌時覺得信息凌亂甚至不堪入目。因此纔有此想法:統一提交模板
1. 模板格式
規範使用較多的是 Angular 團隊的規範,格式如下:
<type>(<scope>): <subject>
// 空出一行
<body>
// 空出一行
<footer>
type: commit 的類型(必填)
- feat: 新特性
- fix: 修改問題
- refactor: 代碼重構
- docs: 文檔修改
- style: 代碼格式修改, 注意不是 css 修改
- test: 測試用例修改
- chore: 其他修改, 比如構建流程, 依賴管理.
- scope: commit 影響的範圍(選填), 比如: route, component, utils, build...
- subject: 提交簡述(必填)
body: commit 具體修改內容(選填)
可以分爲多行
footer: 一些備註(選填)
通常是 BREAKING CHANGE 或修復的 bug 的鏈接.
2. 設置模板
2.1 修改全局配置
在git全局配置裏進行設置,linx/mac 進入文件.gitconfig
$ vi ~/.gitconfig
若不存在[commit] template
,則設置如下
[commit]
template = /Users/zhangguoye/.stCommitMsg
2.2 修改模板
設置模板完畢後,下一步進行模板內容的修改
$ vi /Users/zhangguoye/.stCommitMsg
粘入以下內容保存即可。若使用sourcetree等git管理軟件,則需要重啓軟件才能生效。
<feat>(<>): <提交描述>
<body>
<footer>
# - type:
feat(新特性),
fix(修改問題),
docs(文檔修改),
style(代碼格式修改, 注意不是 css 修改),
refactor(代碼重構),
test(測試),
chore(其他修改, 比如構建流程, 依賴管理)
# - scope: (可以爲空)
影響的的範圍
# - subject
提交描述