git-cz

git-cz:用于生成符合 Conventional Commits 標(biāo)準(zhǔn)的提交消息的工具,以便更規(guī)范地記錄項目的提交歷史。

配置:

  1. 安裝 commitizencz-customizable

    npm install --save-dev commitizen cz-customizable
    
  2. package.json 中配置 config.commitizen

    package.json 文件中添加如下配置:

    "config": {
      "commitizen": {
        "path": "./node_modules/cz-customizable"
      }
    }
    
  3. 添加 .cz-config.js 文件:

    在項目根目錄下創(chuàng)建一個 .cz-config.js 文件,用于配置提交信息的規(guī)范。以下是一個示例配置:

    javascriptCopy code
    module.exports = {
      types: [
        { value: 'feat', name: 'feat:     新增功能' },
        { value: 'fix', name: 'fix:      修復(fù) bug' },
        { value: 'docs', name: 'docs:     文檔變更' },
        { value: 'style', name: 'style:    代碼格式變更(不影響功能,比如空格、格式化、缺失的分號等)' },
        { value: 'refactor', name: 'refactor: 代碼重構(gòu)' },
        { value: 'perf', name: 'perf:     性能優(yōu)化' },
        { value: 'test', name: 'test:     添加或修改測試' },
        { value: 'chore', name: 'chore:    構(gòu)建過程或輔助工具的變更' },
        { value: 'revert', name: 'revert:   回滾到上一個版本' }
      ],
      allowCustomScopes: true,
      allowBreakingChanges: ['feat', 'fix']
    };
    

    這里定義了一些常見的提交類型和相關(guān)的說明。

  4. 使用 git-cz 進行提交: 引導(dǎo)生成符合規(guī)范的提交信息。

    替代使用 git commit,運行以下命令來使用 git-cz

    npx git-cz
    
  5. 提交到版本庫:

    生成的提交信息將自動添加到版本庫,之后可以繼續(xù)推送到遠程倉庫。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容