Git message提交模板

栏目: 编程工具 · 发布时间: 6年前

内容简介：不谈使用git message模板的原因或者历史，网上有一堆。相信针对看到这文章的人都知道，目前自己的版本管理中，追溯提交日志时觉得信息凌乱甚至不堪入目。因此才有此想法：统一提交模板规范使用较多的是 Angular 团队的规范，格式如下：body: commit 具体修改内容（选填）

不谈使用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
    提交描述

以上所述就是小编给大家介绍的《Git message提交模板》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对码农网的支持！

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

挑战编程

斯基纳 / 刘汝佳 / 2009-7 / 39.00元

《挑战编程:程序设计竞赛训练手册》分为14章，分别介绍在线评测系统的基本使用方法、数据结构、字符串、排序、算术与代数、组合数学、数论、回溯法、图遍历、图算法、动态规划、网格、几何，以及计算几何，并在附录中介绍了一些著名的程序设计竞赛以及相应的备赛建议与比赛技巧。每章的正文用十余页的篇幅覆盖了该领域最核心的概念和算法，然后给出八道可在线提交的完整编程挑战题目供读者练习。全书内容紧凑、信息量大......一起来看看《挑战编程》这本书的介绍吧!

码农工具