前沿

前几天写了一个小玩意，帮你百度一下 （放在 github 上可能需要科学上网）。

在用 git 的时候感觉自己每次提的信息都不规范同时也不方便定位信息。

就查找了一下开源项目的规范看了看。在此总结一下。

”工欲善其事，必先利其器“

git 提交规范

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

比如：

feat: 第一版本

1. 实现基本的帮你搜索功能
2. 帮你搜索功能兼容多个国内搜索引擎
3. 帮你搜索功能动画兼容各种设备

如果是参加一些开源项目一般还是使用英文来写

type

表示本次提交的作用

• feat 新功能
• fix 修复bug
• docs 文档更新
• style 代码格式更新
• refactor 重构代码
• test 测试内容提交
• ci 自动构建变化

注意此处并没有严格的限定，可以自行增删使用。

scope（非必须）

表示本次提交影响的模块

ps： 模块各个项目不同，自行定义。

subject

表示主题，用一句话描述本次提交的内容，其实就是标题不宜过长。

body（非必须）

详细描述一下改动的代码，以及功能。一般采用列表的形式罗列出来。

foot（非必须）

指明出本次提交是否出现了破坏性修改（breaking change） 或 issue

破坏性修改（breaking change）是啥？

主要指的是不能向下兼容的改变。

比如：删除某些功能、对参数进行变更

如果出现则必须在提交中指明出来，并且在信息开头要加上 breaking change:

比如：

breaking change: 删除了生成获取ip地址的函数

    修改前：
        function getIp()
        {
            // 此处省略实际代码（此处为演示，实际上应该写上）
        }

issue

表示对项目的提问，一般来说是bug或优化建议。

在提交的时候如果本次提交是涉及到某个问题或者是解决了某个问题。

则可以在 issue 中写明：

# 涉及
issues  #17038,#17031
# 关闭
Closes #17021

注意

本文大部分格式都是按照 Angular 规范 去记录的。

请各位同学按照实际情况参考使用，定义符合自己需求提交格式。