前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >一日一技:为git commit添加默认消息模板

一日一技:为git commit添加默认消息模板

作者头像
青南
发布2019-01-09 16:38:07
3.8K0
发布2019-01-09 16:38:07
举报
文章被收录于专栏:未闻Code未闻Code

我们都很讨厌这样的commit信息:

代码语言:javascript
复制
git commit -m 'update'

因为你看到这个commit信息,不能知道这次的提交究竟是为了什么。是修复了什么bug?是增强了什么功能?等时间久了,需要找以前的某一个提交检查问题的时候,无从下手。

commit信息应该能让人一眼看出这次提交的代码解决了什么问题。下面是一个模板:

代码语言:javascript
复制
[#id] title

[问题描述]
1. ...
2. ...

[问题原因]
1. ...
2. ...

[解决方案]
1. fix ...
2. enhance ...

编号后面是对这一次提交的总结性标题。从第三行开始,是本次提交的详细信息,解决的是什么问题,问题是什么原因,如何解决。

这个信息虽然确实很详细,但是如果每一次都要保持这个格式,未免有些麻烦。因此,可以使用git commit的信息模板来自动生成信息。

首先在创建一个文件: ~/.gitmessage, 其内容如下:

代码语言:javascript
复制
[#id] title

[问题描述]
1. ...
2. ...

[问题原因]
1. ...
2. ...

[解决方案]
1. fix ...
2. enhance ...

接下来,打开配置文件: ~/.gitconfig,在末尾增加两行内容:

代码语言:javascript
复制
[commit]
    template = ~/.gitmessage

保存配置文件。

下一次,当你执行命令: git commit时,就会看到信息模板了。

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2018-12-25,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 未闻Code 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档