其他分享
首页 > 其他分享> > git commit message 规范

git commit message 规范

作者:互联网

Angular提交信息规范

目前最受开发人员肯定的规范是前端框架Angular提出的Angular提交信息规范

提交格式:

Commit Message 包含三个部分,分别是Header、Body、Footer

<type>(<scope>): <subject> 
<BLANK LINE>
<body> 
<BLANK LINE>
<footer>

Angular 规范解读:

其中,Header (第一行)的信息是必须的,其他行信息可以省略;
第一行数据中,type(必选)、scope(可选)、subject(必选),即
其中(<scope>) 也是可以省略的;未省略(<scope>)时,其中的()是不可省略的,<type>(<scope>): 冒号后必须紧跟空格;
在实际开发中,为使得 Commit Message 更为易读;我们往往会限制每行 message 的长度,
常规的限制为 50/72/100 个字符,这里可根据实际情况选用;

Header 该主题包含对更改的简洁描述:

使用命令式,现在时:“change”不是“changed”也不是“changes”
不要大写第一个字母
末尾没有点 (.)

Body

应包括改变的动机,并将其与以前的行为进行对比。

应包含有关重大更改的任何信息,也是引用此提交关闭的 GitHub 问题的地方。

Type

build 影响构建系统或外部依赖项的更改
feat 新增功能
fix Bug修复
perf 代码性能优化
style 代码格式类的变更,格式美化、空格删除等
refactor 其他代码类的修改,这些变更不属于 feat、fix、perf 和 style,例如简化代码、重命名变量、删除冗余代码等
test 新增测试用例或是更新现有测试用例
ci 持续集成和部署相关的改动,比如修改 Jenkins、GitLab CI 等 CI配置文件等
docs 文档类修改,用户文档或开发文档等
chore 其他类型修改,比如构建流程、依赖管理或者辅助工具的变动等

简单理解

代码类修改:有4种具有明确变更意图的类型:feat、fix、perf、style
如果我们的代码不属于这4类,那代码修改都可以归属到 refactor 类,即优化代码

image

简单版的提交示例

git commit -m "feat: user 鉴权"
git commit -m "fix(user): user 权限误判"

标签:git,省略,fix,Angular,修改,commit,message,feat,代码
来源: https://www.cnblogs.com/deja-ve/p/15508517.html