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

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

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

git commit -m 'update'

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

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

[#id] title

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

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

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

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

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

[#id] title

  1. [问题描述]
1. ...
2. ...
  1. [问题原因]
1. ...
2. ...
  1. [解决方案]
1. fix ...
2. enhance ...

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

[commit]
    template = ~/.gitmessage

保存配置文件。

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

目录
相关文章
|
10天前
|
人工智能 缓存 开发工具
结合企业实践来规范你的Git commit(含插件使用指南)
结合企业实践来规范你的Git commit(含插件使用指南)
结合企业实践来规范你的Git commit(含插件使用指南)
|
5月前
|
开发工具 git
Git Commit Msg
Git Commit Msg
|
2月前
|
程序员 开发工具 git
【程序员英语 代码提交】C++工程师的代码提交艺术:git commit 时 精确表达与最佳实践
【程序员英语 代码提交】C++工程师的代码提交艺术:git commit 时 精确表达与最佳实践
92 1
|
3月前
|
前端开发 算法 开发工具
如何将git的多个commit合成一个
如何将git的多个commit合成一个
70 0
|
4月前
|
前端开发 测试技术 持续交付
【开发规范】Git Commit 规范
【1月更文挑战第26天】【开发规范】Git Commit 规范
|
4月前
|
JavaScript 测试技术 持续交付
2020你应该知道的git commit规范
2020你应该知道的git commit规范
91 0
|
4月前
|
开发工具 git
git撤销推送到远端仓库的提交commit信息
git撤销推送到远端仓库的提交commit信息
|
5月前
|
开发工具 git
在偶有几次git commit的时候出现大量额外文件选择提交?
在偶有几次git commit的时候出现大量额外文件选择提交?
44 1
|
5月前
|
开发工具 git
git commit template
git commit template
23 0
|
5月前
|
开发工具 git
git 文件太大,清空历史commit
git 文件太大,清空历史commit
30 0

相关实验场景

更多