前言
上篇 中主要介紹了Vue3中Readme的相關(guān)內(nèi)容∨鑫常看完Readme文檔,對(duì)Vue3的功能及特性有了解后可以開始準(zhǔn)備有的放矢的深入源碼了萍聊。查看源碼的第一步，一個(gè)比較好的方式是先概覽Git Log嘀趟，對(duì)整個(gè)開發(fā)周期中的提交流程開發(fā)流程有一個(gè)粗略的了解脐区。在看Vue3的Log的過程中發(fā)現(xiàn)其規(guī)范和校驗(yàn)方式對(duì)于平時(shí)的業(yè)務(wù)開發(fā)大有裨益，故此本篇分享一下log規(guī)范相關(guān)的內(nèi)容她按。
內(nèi)容
- 打開git可視化工具(mac推薦soureTree 牛隅，window推薦tortoisegit)查看，下圖是vue3的部分注釋截圖酌泰，可以清楚的看的有較標(biāo)準(zhǔn)的格式規(guī)范媒佣。可以通過類型 (feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)及內(nèi)容清晰的區(qū)分出提交的內(nèi)容作用等陵刹。
- vue3的規(guī)范除了約定之外 , ./script/verifyCommit.js中還有專門的格式強(qiáng)制校驗(yàn)默伍，在gitHook commit-msg的鉤子里執(zhí)行校驗(yàn)。提交msg自動(dòng)校驗(yàn)規(guī)范】衰琐，不符合規(guī)范的commit不允提交也糊。
- 那么為什么要有提交規(guī)范呢，使用Git Log規(guī)范一般有3個(gè)目的
- 自動(dòng)生成 CHANGELOG.md
- 識(shí)別不重要的提交
- 為瀏覽提交歷史時(shí)提供更好的信息
- 如何定制一套自己的規(guī)范
這里給出是一套可供參考的注釋規(guī)范 引用參考:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
subject 是對(duì)變更的簡(jiǎn)要描述羡宙。
body 是更為詳細(xì)的描述狸剃。
用于說明 commit 影響的范圍
-
type 則定義了此次變更的類型，可根據(jù)業(yè)務(wù)適當(dāng)增減
fix：?jiǎn)栴}修復(fù) docs：文檔變更 style：代碼風(fēng)格變更（不影響功能） refactor：既不是新功能也不是問題修復(fù)的代碼變更 perf：改善性能 test：增加測(cè)試 chore：開發(fā)工具（構(gòu)建狗热，腳手架工具等） footer 可以包含 Breaking Changes 和 Closes 信息钞馁。
總結(jié)
到這里大家可以回想一下平時(shí)業(yè)務(wù)開發(fā)時(shí)是否有制定相關(guān)的注釋規(guī)范虑省，是約定式的還是強(qiáng)制式的。如果沒有僧凰，且在排查問題查時(shí)已經(jīng)出現(xiàn)無法通過Log區(qū)分出提交的目的和內(nèi)容了探颈，那么就可以在最近迭代的中抓緊制定適合自己項(xiàng)目的注釋規(guī)范了。方式的話训措，建議先約定伪节，視約定的執(zhí)行效果確定是否加入強(qiáng)校驗(yàn)。如果是前端項(xiàng)目尤神的校驗(yàn)代碼可以拿過去簡(jiǎn)單修改直接使用隙弛。如果是其他類型的項(xiàng)目架馋，可以稍微搜索調(diào)研一下，應(yīng)該成本不高全闷。
搜獲關(guān)鍵詞
git log規(guī)范 githook changlog
發(fā)散問題
- 如果是java或者god等其他語言的項(xiàng)目，一般通過什么樣的方式做git log的格式校驗(yàn)萍启，是否有通用的校驗(yàn)方式
以上問題总珠，平時(shí)在工作中有了解或者有最佳實(shí)踐的同學(xué)也可以不吝分享一起探討提高
