github commit 規范


最近對代碼review時候發現commit寫的。。。。。emmmm不忍直視,根本亂的一匹。很難梳理每一次提交都在寫什么,甚至有的直接commit 1 所以專門整理了一篇關於commit的規范,如下:

github commit 應該包含四個信息

  • type(必需)、scope(可選)和subject(必需)、body (可選)

type

feat :新功能 

fix :修復bug  

docs : 文檔改變

style : 代碼格式改變

refactor :某個已有功能重構

perf :性能優化

test :增加測試/測試用例

revert: 撤銷上一次的 commit 

chore: 改變構建流程、或者增加依賴庫、工具等

Init:新建庫

build :改變了build工具 如 grunt換成了 npm

scope

scope用於說明 commit 影響的范圍,比如數據層、控制層、視圖層等等,視項目不同而不同。

subject

subject是 commit 目的的簡短描述,不超過50個字符。
以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes
第一個字母小寫
結尾不加句號(.)

Body 

對本次 commit 的詳細描述,可以分成多行。

歡迎各位大佬指教


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM