一文教你如何设置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显示内容与提交模板一致。

一文教你如何设置git commit模板规范相关推荐

git commit 模板设置
上周在看同学的项目代码的时候发现他的项目的git log 非常规范,例如每次提交的问题,出现的原因,解决方案,作者等条目都很清晰,一目了然.后来问题了一下,说是设置git commit 模板,我竟然 ...
git-cz 一款git commit 统一规范的工具
git-cz 一款git commit 统一规范的工具介绍:git commit 就是你在修改代码后写一个备注,如果安装了commitizen后,你可以使用git cz取代git commit,每次 ...
Git commit hook 规范标准配置
Git每次提交代码都需要写commit message,否则就不允许提交.一般来说,commit message应该清晰明了,说明本次提交的目的,具体做了什么操作--但是在日常开发中,大家的commi ...
Git Commit 提交规范
本项目以目前使用较多的 Angular 团队规范 Conventional Commits specification(约定式提交) 为例. git hook 官方文档 git 提交时,主要分为三部分 ...
git commit提交规范
Commit message 都包括三个部分:header,body 和 footer,其中 header 有一个特殊的格式,包括了 type.scope.subject. <type>( ...
你确定你会使用git commit?
我记得刚工作的时候,我第一次写git commit的内容,直接上来就是一个git commit -m "加上自己的注释",就这样提交了. 后来,我去了中兴,又去了恒大,接触到很多人 ...
git 工作流和git commit规范
目的统一团队的Git工作流,包括分支使用.tag规范.issue等统一团队的Git Commit日志标准,便于后续代码review,版本发布以及日志自动化生成 git工作流 git flow工作流 ...
利用5w1h写出高效的git commit
创建git commit 模板创建模板在个人目录下, 创建 .gitmessage vi .gitmessage 复制代码并输入以下信息 Who: Demand maker*When: vers ...
git commit 代码提交规范
1. 前言每个人 git 的提交记录都有自己的风格和习惯,特别是多人协作开发的项目,如果没有一套完整的规范,则每个人的代码提交描述内容会很随意,质量参差不齐,会降低 log 的可读性和维护性.所以, ...

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

一、git log之痛

二、步骤

一文教你如何设置git commit模板规范相关推荐

最新文章

热门文章