一日一技:为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时,就会看到信息模板了。

目录
相关文章
|
2月前
|
自然语言处理 前端开发 数据可视化
Quarto ppt模板制作与Rstudio git连接
本文介绍了当前PPT演示中流行的Quarto文档使用情况,以及如何在Rstudio中连接Git进行版本控制。重点讲解了Quarto的ppt模板制作流程,包括安装、创建演示文稿及自定义样式等步骤,并提供了相关资源链接。
46 0
Quarto ppt模板制作与Rstudio git连接
|
3月前
|
开发工具 git
GIT:如何合并已commit的信息并进行push操作
通过上述步骤,您可以有效地合并已提交的信息,并保持项目的提交历史整洁。记得在执行这些操作之前备份当前工作状态,以防万一。这样的做法不仅有助于项目维护,也能提升团队协作的效率。
164 4
|
3月前
|
开发工具 git
GIT:如何合并已commit的信息并进行push操作
通过上述步骤,您可以有效地合并已提交的信息,并保持项目的提交历史整洁。记得在执行这些操作之前备份当前工作状态,以防万一。这样的做法不仅有助于项目维护,也能提升团队协作的效率。
280 3
|
4月前
|
开发工具 git
Git——commit的提交规范
Git——commit的提交规范
112 4
|
4月前
|
测试技术 持续交付 开发工具
[译] 为何每次 Git Commit 要尽可能小?
[译] 为何每次 Git Commit 要尽可能小?
|
4月前
|
Java 开发工具 Android开发
Android Studio利用Build.gradle导入Git commit ID、Git Branch、User等版本信息
本文介绍了在Android Studio项目中通过修改`build.gradle`脚本来自动获取并添加Git的commit ID、branch名称和用户信息到BuildConfig类中,从而实现在编译时将这些版本信息加入到APK中的方法。
95 0
|
5月前
|
前端开发 JavaScript 开发工具
前端优化之路:git commit 校验拦截
前面在git分支规范那篇文章里,介绍了commit提交规范,但是想要做到高效落地执行,就需要做些别的功课。
|
4月前
|
IDE 开发工具 git
我是怎么写 Git Commit message 的?
我是怎么写 Git Commit message 的?
55 0
|
6月前
|
存储 开发工具 git
蓝易云 - git中,add到暂存区,commit且push之后,暂存区域里还有内容吗
所以,当你执行 `git add`,然后是 `git commit`,最后是 `git push`之后,暂存区是空的,除非你又执行了新的 `git add`命令来添加更多的更改。
51 1
|
6月前
|
开发工具 git
一文教你如何设置git commit模板规范
一文教你如何设置git commit模板规范