一文教你如何设置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月前
|
开发工具 git
使用Git下载指定版本或指定commit
使用Git下载指定版本或指定commit
|
3月前
|
存储 人工智能 缓存
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
160 3
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
|
4月前
|
JavaScript 前端开发 持续交付
实际工作中 Git Commit 代码提交规范是什么样的?
实际工作中 Git Commit 代码提交规范是什么样的?
220 7
|
6月前
|
人工智能 前端开发 Java
用git rebase命令合并开发阶段中多条commit提交记录
通过 `git rebase`,可以合并多个提交记录,使开发历史更简洁清晰。操作分为 6 步:查看提交历史 (`git log --oneline`)、设置需合并的提交数 (`git rebase -i HEAD~N`)、修改动作标识为 `s`(squash)、保存退出编辑、调整提交信息、强制推送至远程仓库 (`git push -f`)。此方法适合清理本地无关提交,但若有团队协作或冲突风险,需谨慎使用以避免问题。
837 60
|
5月前
|
前端开发 开发工具 git
Git报错处理:解决git commit时的lint-staged错误提示。
极好的,你对Git的lint-staged出了一个令人头疼的问题。让我们一起钻研一下,找到一种方法来解决一切。 首先,我们要确定你是在做什么操作时候遇到了问题。lint-staged通常在我们运行 git commit 时启动,它做的工作是在你提交之前运行一些指定的命令检查你的代码。当lint-staged报错,多半是因为检查未通过,或者它试图运行的命令存在问题。 让我们以一种图解的方式来描绘一下这个过程,就像canvas上的画面那样。git正在温柔的将你的修改捆绑起来,准备提交。突然,lint-staged走了出来,并开始盘问着Git,寻找可能的错误。如果lint-staged找到了什么
645 24
|
11月前
|
自然语言处理 前端开发 数据可视化
Quarto ppt模板制作与Rstudio git连接
本文介绍了当前PPT演示中流行的Quarto文档使用情况,以及如何在Rstudio中连接Git进行版本控制。重点讲解了Quarto的ppt模板制作流程,包括安装、创建演示文稿及自定义样式等步骤,并提供了相关资源链接。
295 0
Quarto ppt模板制作与Rstudio git连接
|
3月前
|
安全 开发工具 git
git的常用操作命令
git的常用操作命令
292 57
|
4月前
|
存储 项目管理 开发工具
Git常用命令及操作技巧
以上是Git的常用命令及操作技巧,尽管看起来有些繁琐,但实际上只要花费一些时间进行实践,您将很快熟练掌握。随着使用熟练度的提高,您会发现Git对项目管理和协同工作的强大帮助。
127 20
|
5月前
|
Linux 开发工具 git
版本控制工具:Git的安装和基本命令使用指南。
结束这段探险,掌握了Git你就等于掌握了一个宝藏,随时可以瞥见你的编程历程,轻松面对日后的挑战。Git,无疑是编程者的强大武器,开始你的Git探险之旅吧!
204 28
|
10月前
|
开发工具 git
git 常用命令
这些只是 Git 命令的一部分,Git 还有许多其他命令和选项,可根据具体需求进行深入学习和使用。熟练掌握这些命令能够帮助你更高效地管理代码版本和协作开发。