ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

git commit message 规范

2021-11-04 16:02:16  阅读:290  来源: 互联网

标签:git 省略 fix Angular 修改 commit message feat 代码


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

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有