直接用ip访问网站,做进出口外贸网站,wordpress简书主题,google ads 推广文章目录 前言介绍使用约定式提交规范的好处提交信息格式信息头部#xff08;Header#xff09;正文#xff08;Body#xff09;脚注#xff08;Footer#xff09;撤销#xff08;Revert#xff09; 提交类型表格官网 前言介绍
约定式提交规范它是一种基于提交信息的轻… 文章目录 前言介绍使用约定式提交规范的好处提交信息格式信息头部Header正文Body脚注Footer撤销Revert 提交类型表格官网 前言介绍
约定式提交规范它是一种基于提交信息的轻量级约定提供了一组简单规则来创建清晰的提交历史。 使用约定式提交规范的好处
使用约定式提交规范的好处有哪些呢
提高开发效率通过这种 “约定大于配置” 的思想约定式提交减少了软件开发人员需要做的决定数量从而提升了开发效率。便于历史记录和版本控制约定式提交要求每次使用 git commit 时都需要写 commit message并且如果 message 的 style 是按照固定的模板格式书写这对于后期的维护和编写 changelog更新版本 都有巨大的好处。按照这个格式看起来一目了然。提升代码可读性约定式提交通过使用固定的模板格式书写提交信息使得commit message具有更好的可读性清晰明了。这不仅便于团队成员之间的沟通和协作也为 Code Reviewing 做好了准备无需深入查看代码即可了解当前 commit 的作用。减少错误和混乱通过规范化提交无论是文中提到的具体方式还是其他统一、简明的方式可以避免在 commit 时五花八门的提交信息减少在处理问题时耗费的时间。这有助于提高代码库的质量和可维护性避免因提交信息不规范而导致的混乱和错误。 提交信息格式
类型[可选 范围]: 描述[可选 正文][可选 脚注]信息头部Header
Header 部分只有一行包括三个字段type必需、scope可选和 subject必需。
Type 使用的类型哪一个请看下面的提交类型表格。
Scope 用于说明提交影响的范围比如数据层、控制层、视图层等每个项目的架构不同所以视角是不一样的。
Subject 是提交目的的简短描述不超过50个字符。 正文Body
Body 部分是对本次 Commit 的详细描述可以分成多行。 脚注Footer
Footer 部分一般用于两种情况。 1、不兼容变动如果当前代码与上一个版本不兼容则 Footer 部分以 BREAKING CHANGE 开头后面是对变动的描述、以及变动理由和迁移方法。 2、关闭 Issue、项目内部测试案例或者关闭项目内部BUG号比如说当前 Commit 针对某个 issue那么可以在 Footer 部分写上关闭这个 issue 。 如Close #234, #123 撤销Revert
Revert 是一种特殊情况用于撤销以前的 Commit。其必须以 revert: 开头后面跟着被撤销 Commit 的 Header。 而 Revert 中的 Body 部分是有一种固定格式的则需要写成 This reverts commit commit_id
revert: feat ✨: 添加用户功能This reverts commit bc3f0184.注意以上不管是哪一个部分任何一行都不得超过 72 个字符或100个字符这是为了避免自动换行影响美观。 提交类型表格
提交类型标题描述EmojifeatFeatures新增功能✨fixBug Fixes修复 BUGdocsDocumentation修改文档styleStyles不影响代码含义的更改空格、格式、缺少分号等refactorCode Refactoring代码重构无新功能或修复BugperfPerformance Improvements优化相关比如提升性能体验testTests增加测试用例包括单元测试集成测试等buildBuilds影响构建系统或外部依赖项的更改示例范围gulp、broccoli、npmciContinuous Integrations对我们的 CI 配置文件和脚本的更改示例范围Travis、Circle、BrowserStack、SauceLabs⚙️choreChores改变构建流程增加依赖库工具等♻️revertReverts回滚到上一个版本 官网
官网地址可以去查看原文 End
