Git message提交模板

時間 2019-11-21

標籤 git message 提交模板欄目 Git 简体版

原文原文鏈接

不談使用git message模板的緣由或者歷史，網上有一堆。相信針對看到這文章的人都知道，目前本身的版本管理中，追溯提交日誌時以爲信息凌亂甚至不堪入目。所以纔有此想法：統一提交模板

1. 模板格式

規範使用較多的是 Angular 團隊的規範，格式以下：css

<type>(<scope>): <subject>
// 空出一行
<body>
// 空出一行
<footer>

type: commit 的類型（必填）git

feat: 新特性
fix: 修改問題
refactor: 代碼重構
docs: 文檔修改
style: 代碼格式修改, 注意不是 css 修改
test: 測試用例修改
chore: 其餘修改, 好比構建流程, 依賴管理.
scope: commit 影響的範圍（選填）, 好比: route, component, utils, build...
subject: 提交簡述（必填）

body: commit 具體修改內容（選填）
能夠分爲多行github

footer: 一些備註（選填）
一般是 BREAKING CHANGE 或修復的 bug 的連接.測試

2. 設置模板

2.1 修改全局配置

在git全局配置裏進行設置，linx/mac 進入文件.gitconfigui

$ vi ~/.gitconfig

若不存在[commit] template，則設置以下日誌

[commit]
        template = /Users/zhangguoye/.stCommitMsg

2.2 修改模板

設置模板完畢後，下一步進行模板內容的修改code

$ vi  /Users/zhangguoye/.stCommitMsg

粘入如下內容保存便可。若使用sourcetree等git管理軟件，則須要重啓軟件才能生效。component

<feat>(<>): <提交描述>

<body>

<footer>

# - type: 
    feat(新特性), 
    fix(修改問題), 
    docs(文檔修改), 
    style(代碼格式修改, 注意不是 css 修改), 
    refactor(代碼重構), 
    test(測試), 
    chore(其餘修改, 好比構建流程, 依賴管理)
# - scope: (能夠爲空)
    影響的的範圍
# - subject
    提交描述

3. Commitizen

另外有人說用 Commitizen 替代 git commit，我就不發表意見了。但仍是建議新手少折騰。
有興趣的能夠自行了解下：
commitizen ：https://github.com/commitizen...
cz-conventional-changelog：https://github.com/commitizen...文檔

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。