看vue3源码能够学到什么 : 2、Git Log规范

时间 2019-11-06

标签 vue3 vue 源码能够学到什么 git log 规范栏目 Git 繁體版

原文原文链接

前言

上篇中主要介绍了Vue3中Readme的相关内容。看完Readme文档,对Vue3的功能及特性有了解后能够开始准备有的放矢的深刻源码了。查看源码的第一步，一个比较好的方式是先概览Git Log，对整个开发周期中的提交流程开发流程有一个粗略的了解。在看Vue3的Log的过程当中发现其规范和校验方式对于平时的业务开发大有裨益，故此本篇分享一下log规范相关的内容。html

内容

打开git可视化工具(mac推荐soureTree ，window推荐tortoisegit)查看，下图是vue3的部分注释截图，能够清楚的看的有较标准的格式规范。能够经过类型 (feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)及内容清晰的区分出提交的内容做用等。

vue3的规范除了约定以外 , ./script/verifyCommit.js中还有专门的格式强制校验，在gitHook commit-msg的钩子里执行校验。提交msg自动校验规范】，不符合规范的commit不允提交。

那么为何要有提交规范呢，使用Git Log规范通常有3个目的

自动生成 CHANGELOG.md
识别不重要的提交
为浏览提交历史时提供更好的信息

如何定制一套本身的规范
这里给出是一套可供参考的注释规范 引用参考:

<type>(<scope>): <subject>
    <BLANK LINE>
    <body>
    <BLANK LINE>
    <footer>
复制代码

subject 是对变动的简要描述。前端
body 是更为详细的描述。vue
用于说明 commit 影响的范围java

type 则定义了这次变动的类型，可根据业务适当增减git

fix：问题修复
docs：文档变动
style：代码风格变动（不影响功能）
refactor：既不是新功能也不是问题修复的代码变动
perf：改善性能
test：增长测试
chore：开发工具（构建，脚手架工具等）
footer 能够包含 Breaking Changes 和 Closes 信息。
复制代码

总结

到这里你们能够回想一下平时业务开发时是否有制定相关的注释规范，是约定式的仍是强制式的。若是没有，且在排查问题查时已经出现没法经过Log区分出提交的目的和内容了，那么就能够在最近迭代的中抓紧制定适合本身项目的注释规范了。方式的话，建议先约定，视约定的执行效果肯定是否加入强校验。若是是前端项目尤神的校验代码能够拿过去简单修改直接使用。若是是其余类型的项目，能够稍微搜索调研一下，应该成本不高。bash

搜获关键词

git log规范 githook changlog工具

发散问题

若是是java或者go等其余语言的项目，通常经过什么样的方式作git log的格式校验，是否有通用的校验方式

以上问题，平时在工做中有了解或者有最佳实践的同窗也能够不吝分享一块儿探讨提升post