git commit規範化實踐

来源:https://www.cnblogs.com/xzsty/archive/2019/07/25/11244981.html
-Advertisement-
Play Games

最近從svn轉到git進行代碼版本控制,今天瞭解了git commit規範化的一些知識後,寫此文章記錄下配置過程。 環境 編輯器使用的是vscode,項目框架是vue3.0 規範化工具 規範化git commit消息的工具commitizen 安裝完之後我們就項目中引進改工具,就可以規範commit ...


最近從svn轉到git進行代碼版本控制,今天瞭解了git commit規範化的一些知識後,寫此文章記錄下配置過程。

環境

編輯器使用的是vscode,項目框架是vue3.0

規範化工具

規範化git commit消息的工具commitizen

 # 將commitizen命令行安裝到全局
npm install -g commitizen

安裝完之後我們就項目中引進改工具,就可以規範commit行為了。提交的命令為git cz,如果還是用git commit命令進行提交,那麼這個工具就不會起到什麼作用了。

commitizen對commit規範化界面都是英文提示,這個時候我就想如果要漢化怎麼辦,這就有了下麵一個工具的出現。

安裝可定製的Commitizen插件cz-customizable

npm install cz-customizable --save-dev

安裝cz-customizable可以配置自定義的commitizen配置文件,在自定義的配置文件中我就可以對配置進行漢化

  "config": {
    "commitizen": {
      "path": "./node_modules/cz-customizable"
    },
    "cz-customizable": {
      "config": "my.cz-config.js" // 這裡的文件名可以自定義,但是改文件需要放置在項目的根目錄下
    }
  }

漢化完之後的效果是下麵這樣:

版本發佈

進行commit規範化的好處是為了提高團隊協作效率,使代碼閱讀性更強。還有另外一個節省後期維護版本信息的成本。通過規範化commit行為,我們可以通過自動化工具生成版本信息這樣極大的降低了維護成本,提高了工作效率。在這裡我使用的版本發佈工具是standard-version,當然還有conventional-changelog可以使用。

standard-version可以自動幫助我們做以下幾件事情:

  1. 自動在數據中生成版本號
  2. 使用conventional-changelog更新 CHANGELOG.md
  3. 提交package.json (如果有) 和 CHANGELOG.md
  4. 給新版本打一個tag

首先是安裝standard-version

npm i standard-version --save-dev

安裝完成之後,執行standard-version命令,在控制台可以看到如下信息:

可以清楚的看到standard-version做了哪些事情。其中package.json和changelog.md文件是被自動提交了的。這樣在項目中生成了一個changelog文件

# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [0.3.2](http://112.80.40.2:11080/chenchent/cdss-acs/compare/v0.3.1...v0.3.2) (2019-07-25)



### [0.3.1](http://112.80.40.2:11080/chenchent/cdss-acs/compare/v0.3.0...v0.3.1) (2019-07-25)


### Bug Fixes

* 將commitizen使用本地配置文件 ([4accd0a](http://112.80.40.2:11080/chenchent/cdss-acs/commit/4accd0a))



## [0.3.0](http://112.80.40.2:11080/chenchent/cdss-acs/compare/v0.2.0...v0.3.0) (2019-07-25)

### Bug Fixes

- **changelog:** 生成新的 changelog 文件 ([17747cf](http://112.80.40.2:11080/chenchent/cdss-acs/commit/17747cf))

### BREAKING CHANGES

- **changelog:** 測試

## 0.2.0 (2019-07-25)

### Features

- **me:** 測試 ([64e596d](http://112.80.40.2:11080/chenchent/cdss-acs/commit/64e596d))

# 0.1.0 (2019-07-25)

### Features

- **me:** 測試 ([64e596d](http://112.80.40.2:11080/chenchent/cdss-acs/commits/64e596d))

由於我習慣於使用node命令,所以最後我又將規範化跟版本生成的命令配置到了scripts中

  "scripts": {
    "commit": "git cz",
    "changelog": "standard-version --dry-run && standard-version" 
# standard-version --dry-run只是用來列印要做的事情,並不會做實際的操作
  }

這就是我對git commit規範化的一些實踐。mark下來做一個記錄,希望可以幫助到其他人。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 前言:做一名Web設計師是一件令人興奮的事。在Web技術中,JavaScript是一個經歷從被人誤解到萬眾矚目的巨大轉變,在歷史的衝擊中被留存下來的個體。因為JavaScript的引導,Web開發也從混亂無序的狀態轉變為需要經過嚴格訓練才能勝任的工作。當大家談論起Web開發時,自然會提到Web標準中 ...
  • 說明 Node.js中,以非同步(Async)回調著稱,使用了非同步,提高了程式的執行效率,但是,代碼可讀性較差的。 假如有幾個非同步操作,後一個操作需要前一個操作的執行完畢之後返回的數據才能執行下去,如果使用Node.js,就需要一層層嵌套下去,Promised對象就是針對此問題所提出來的的解決辦法。 ...
  • 需求 隨著Nodejs的普及,前端開發的開發場景基本可以貫穿界面交互到數據存儲,無縫實現全棧開發。最近在實現一個內部項目管理工具的時候,就嘗試了一把介面和資料庫開發。 什麼是Egg.js Egg.js是阿裡開源的一套Nodejs開發框架。Egg.js官網的介紹是: Egg.js 為企業級框架和應用而 ...
  • @media screen and (max-width:375px) { //小於等於375可以進入 html { background: red; } } 由此可見,邊界都包含在內。 更多參考連接 https://www.runoob.com/cssref/css3-pr-mediaquery. ...
  • 聲明:本文基於JavaScript環境編寫。 前言 按照目前的項目需求,我們需要在谷歌地圖上標記出當前倉庫的位置、司機補貨的行車路徑、司機當前班次需要補貨的機器的位置,同時根據補貨狀態的不同標記成不同狀態的圖標。 分析完需求,總結一下就是我們需要在谷歌地圖上顯示眾多標記、軌跡畫線、不同的標記顯示不同 ...
  • 一、什麼是HTML hyper text markup language 即超文本標記語言 超文本: 就是指頁面內可以包含圖片、鏈接,甚至音樂、程式等非文字元素。 標記語言: 標記(標簽)構成的語言. 網頁==HTML文檔,由瀏覽器解析,用來展示的 靜態網頁:靜態的資源,如xxx.html 動態網頁 ...
  • 嚴謹的規則匹配 簡單匹配 ...
  • 一項目創建 1,搭建vue-cli腳手架(依賴npm) 沒有安裝npm的同學,請先使用npm install -g vue-cli ,然後再進行這一步 安裝的過程中有幾項 ? Project name p1 //項目名? Project description 1 //描述? Author jims ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...