git如何配置模板文件

git如何创建模板文件

  1. 创建xxx_template文件,其内容为团队制定的Git提交注释规范,如:
Desgraption: 
Date: 
Author:
  1. 通过git config命令配置commit_template
git config –global commit.template %模板文件位置%

PS:与团队成员约定做git提交时使用git commit,不能直接用git commit -m跳过规范。

其他的模板文件

  1. 例1
<type>(scope): subject

下面是模板的解释不用添加到文件中
解释:
type:新增|修复|优化|删除|文档|格式|测试
新增–新添加需求功能
修复–bug类修复
优化–针对于某一行、一段、模块代码优化
删除–删除功能、无用代码
文档–涉及文档说明修改
格式–代码格式调整
测试–测试代码
scope:用于描述改动的范围,服务端格式为终端/模块,前端格式为模块
subject:变动主题描述

  1. 例2
[需求/BUG]:
[模块]:
[说明]:
  1. 例3
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

1、 Header

Header部分有3个字段: type(必需), scope(可选), subject(必需)
type(必需) : Type of change:commit的类别;
scope(可选):Scope of this change:此次commit的影响模块;
subject(必需):Short description:简短的描述此次代码变更的主要内容

2、Body
Body 部分是对本次 commit 的详细描述,如果Header中subject已经描述清楚此次代码变更的内容后,Body部分就可以为空。

3、Footer

(1)不兼容变动
(2)关闭 Issue
日常项目中开发,Footer不常用,可为空。

idea插件

IDEA插件Git Commit Template可以配合模板文件使用

你可能感兴趣的:(常用技巧,git,github)