Git commit注釋規范


指定規范的提交格式, 方便后期版本的回滾與記錄的查詢

 

格式規范:

<type>(<scope>): <subject>
// 空一行
<body>

范例:

fix: feat(0429留言下單): add 'graphiteWidth' option

提交的具體情況
  •   type:說明commit的類別, 只允許使用下面8中標識
    •   br:針對bug號,用於項測試反饋bug列表的bug修改情況
    • feat:新功能
    • fix:修復bug
    • docs:文檔
    • style:格式(不影響代碼運行的變動)
    • refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
    • test:增加測試
    • chore:構建過程或輔助工具的變動
    • revert:feat(pencil): add 'graphiteWidth' option (撤銷之前的commit)

 

  •   scope:用於說明 commit 影響的范圍,比如數據層、控制層、視圖層等等,視項目不同而不同。
    •   subject:subject是 commit 目的的簡短描述,不超過50個字符。
    • 以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes
    • 第一個字母小寫
    • 結尾不加句號(.)

 

  •   body:Body 部分是對本次 commit 的詳細描述,可以分成多行

 


免責聲明!

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



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