看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