专栏首页进击的Coder一日一技:为 git commit 设置默认模板

一日一技:为 git commit 设置默认模板

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

git commit -m  'update'

当大量的提交都写着“update”的时候,你根本没法快速知道每个提交改的是什么内容——是修复了什么bug?是增强了什么功能?等时间久了,需要找以前的某一个提交检查问题的时候,无从下手。

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

[#id] title

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

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

[解决方案]
1. ...
2. ...
3. ...

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

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

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

[#id] title

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

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

[解决方案]
1. ...
2. ...
3. ...

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

[commit]
template = ~/.gitmessage

保存配置文件。

下一次,当你执行命令:git commit时,这个模板就会自动弹出来了。

本文分享自微信公众号 - 进击的Coder(FightingCoder)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-06-24

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 世界杯来了!谁能夺冠?让我们用数据说话

    2018年,火热的世界杯即将拉开序幕。在比赛开始之前,我们不妨用 Python 来对参赛队伍的实力情况进行分析,并大胆的预测下本届世界杯的夺冠热门球队。

    崔庆才
  • 对你没有看错!不到 10 行代码完成抖音热门视频的爬取!

    最近研究了一下抖音的爬虫,目前实现了热门话题和热门音乐下面所有相关视频的爬取,并且我已经将该爬虫打包成了一个 Python 库并发布,名称就叫做 douyin,...

    崔庆才
  • 一篇文章带你登顶 MacBook 高效工作环境配置

    笔记本电脑的特点是携带方便,缺点是屏幕太小,因此你首先需要再申请领用一个外接显示器,多一个屏幕会大大减少你切换应用程序的次数,显著提升你的工作效率,别忘了同时申...

    崔庆才
  • 一日一技:为 git commit 设置默认模板

    当大量的提交都写着“update”的时候,你根本没法快速知道每个提交改的是什么内容——是修复了什么bug?是增强了什么功能?等时间久了,需要找以前的某一个提交检...

    青南
  • 使用Prometheus监控snmp

    此外还需要自己编译生成snmp exporter的配置文件,首先需要配置generator.yml文件,然后按照Building和Running中的步骤编译生成...

    charlieroro
  • 键盘工具栏的快速集成--IQKeyboardManager

    用户1941540
  • 键盘工具栏的快速集成--IQKeyboardManager

    用户1941540
  • 蛋白质组学第1期-认识基础概念

    简而言之:蛋白质组就是一个特定的生物系统中(特定时间、空间)存在的所有蛋白质及其相互作用

    生信技能树
  • GoPro API for Python

    用于Python的非官方GoPro API库-通过WiFi连接到GoPro摄像机。

    云深无际
  • 【开源公告】腾讯第三代高性能计算平台Angel 正式全面开源

    Angel 项目简介 Angel是一个基于参数服务器(Parameter Server)理念开发的高性能分布式机器学习框架,在其之上,用户能轻松开发适用于高维度...

    腾讯开源

扫码关注云+社区

领取腾讯云代金券