一文教你如何设置git commit模板规范

简介: 一文教你如何设置git commit模板规范

一、git log之痛

今天看公司代码的提交历史,发现信息量过少,甚至是误导的commit message非常常见,并且无法定位到禅道的相关任务(有的公司用的是jira),对新人来说,查找以往的提交记录很不友好。

为方便新人更快更准确的理解工程师所提交的需求或缺陷,git在提交时需要指定格式提交,下面给git配置一个提交模板,配置好后,每次gitcommit时都会将模板中的信息作为初始化信息自动填充到编辑器的提交信息中。


二、步骤

1、以命令的方式配置,在git中输入以下命令

 git config --global commit.template ~/.git-commit-template


2、打开.gitconfig文件,发现以命令的方式执行后,它会自动在.gitconfig配置文件中生成这一项,git commit的时候就会去配置文件中读取这一项指定的文件中的内容作为初始化信息填写到提交信息中。

3、在.gitconfig文件的同级目录下新建以.git-commit-template命名的文本文件,并把下面的模板拷贝到该文件中保存即可。

[修改类型]

[原因分析]
[影响范围]
[Task_id]

#[修改类型] 修改内容
#
#[原因分析]
#[影响范围] 填写模块名称
#[Task_id] 禅道任务ID

#修改类型 :
#1.config :简单配置需求
#2.bugfix :由缺陷主导的代码修改
#3.feature :功能模块的添加,与bugfix独立

#修改内容:
#此次修改的简要标题,标题简要的描述修改的主要目的(不超过20个汉字,80个字符)

#原因分析:
#针对提交进行的原因描述

#影响范围:
#填写模块名称

#[Task_id] 添加关联的禅道任务ID,没有则需要确认是否需要新建任务

修改类型根据需求修改为对应的config/feature/bugfix。git log显示内容与提交模板一致。

相关文章
|
2月前
|
自然语言处理 前端开发 数据可视化
Quarto ppt模板制作与Rstudio git连接
本文介绍了当前PPT演示中流行的Quarto文档使用情况,以及如何在Rstudio中连接Git进行版本控制。重点讲解了Quarto的ppt模板制作流程,包括安装、创建演示文稿及自定义样式等步骤,并提供了相关资源链接。
42 0
Quarto ppt模板制作与Rstudio git连接
|
2月前
|
前端开发 开发工具 git
如何清理 docker 磁盘空间+修改 Gitea 服务器的 Webhook 设置+前端一些好学好用的代码规范-git hook+husky + commitlint
如何清理 docker 磁盘空间+修改 Gitea 服务器的 Webhook 设置+前端一些好学好用的代码规范-git hook+husky + commitlint
35 5
|
3月前
|
开发工具 git
GIT:如何合并已commit的信息并进行push操作
通过上述步骤,您可以有效地合并已提交的信息,并保持项目的提交历史整洁。记得在执行这些操作之前备份当前工作状态,以防万一。这样的做法不仅有助于项目维护,也能提升团队协作的效率。
158 4
|
3月前
|
开发工具 git
GIT:如何合并已commit的信息并进行push操作
通过上述步骤,您可以有效地合并已提交的信息,并保持项目的提交历史整洁。记得在执行这些操作之前备份当前工作状态,以防万一。这样的做法不仅有助于项目维护,也能提升团队协作的效率。
273 3
|
4月前
|
消息中间件 小程序 Java
【规范】看看人家Git提交描述,那叫一个规矩
本文通过IDEA中的Git描述规范插件【git commit message helper】,介绍了Git提交描述的规范流程,强调了团队开发中统一标准的重要性,并通过实例展示了规范的提交记录如何提高代码管理和维护效率。最后,文章提供了几个实用的Git提交描述案例,帮助读者更好地理解和应用这些规范。
133 0
【规范】看看人家Git提交描述,那叫一个规矩
|
4月前
|
敏捷开发 小程序 持续交付
【规范】Git分支管理,看看我司是咋整的
本文介绍了Git分支管理规范的重要性及其在企业中的应用。通过规范化的分支管理,可加速团队协作、确保代码质量、维护主分支稳定,并支持敏捷开发。文中详细描述了主分支(如master、develop)和辅助分支(如feature、hotfix)的作用,并提供了实际开发流程示例,包括开发前、开发中、提测、预生产和部署上线等阶段的操作方法。旨在帮助团队提高效率和代码质量。
294 0
【规范】Git分支管理,看看我司是咋整的
|
4月前
|
开发工具 git
【Azure App Service】App Service设置访问限制后,使用git clone代码库出现403报错
【Azure App Service】App Service设置访问限制后,使用git clone代码库出现403报错
|
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中的方法。
88 0
|
4月前
|
存储 测试技术 开发工具
企业Git 规范的必要性-阿里云开发者社区
既然认同需要一份 Git 规范,那么这个规范需要规范哪些内容,解决哪些问题。