Git版本控制工具使用說明和規範

2021-10-20 02:19:54 字數 3903 閱讀 6869

windows環境下的git版本控制工具使用說明和規範。

目錄

1 git的安裝與使用

2 git的使用規範

3 工欲善其事必先利其器

git 是linux 開源社群為linux的開發與維護而開發的乙個專案,目前已被廣泛應用,關於版本控制工具各有特點,本部門全部使用git,軟體開發前必須熟練掌握git的使用,以及遵守相應操作規範。

伺服器端已經安裝在內網伺服器,本文針對window平台的git客戶端的安裝和使用。

1、安裝tortoisegit-2.5.0.0-64bit.msi 一路下一步,這只是安裝了git的核心功能,要在windows下操作,需要安裝介面外殼。

2、安裝gitextensions-2.50.02-setupcomplete.msi 或者 git-2.15.0-64-bit.exe,這是兩種風格的介面,主體功能差不多,個人選擇的是後者,也可以兩個都安裝。

3、安裝過程**現較多的配置,所有選項中,全部都選帶windows關鍵字的,否則用起來看不出問題,但是儲存的記錄異常。既然是介面操作,就開啟滑鼠右鍵的快捷圖示。

後續一些安裝選項,全部選帶windows關鍵字的。

4、安裝完成後,滑鼠右鍵,會出現 git gui here。

5、如果是新手可安裝漢化補丁tortoisegit-languagepack-2.5.0.0-64bit-zh_cn.msi。

1、配置

其中使用者名稱必須使用自己名字的全拼,不要使用簡寫或者其他特殊字元,以方便後期檢索跟蹤修改記錄。

2、建立本地版本庫,git creat repository here,預設操作,即可建立版本,會在test空資料夾下生成.git 。

3、在test下隨便改動,如新加123.txt,提交改動。此時滑鼠右鍵效果如下:

4、編輯本次修改記錄

修改記錄必須簡潔清晰,具體規範參考下一章。

5、儲存本次修改後,使用git gui here->repository->visualize master』s history檢視全部版本記錄。

6、提交到遠端伺服器

7、同步遠端分支

有時候提示提交推送失敗,先確定是否伺服器有新節點,先同步、合併(rebase)後再提交。

8、分支合併

一般選擇rebase,但其實它有缺點。特別提醒,進行reabse前先將當前分支新加分支名,以防操作失敗,節點錯亂導致當前節點消失。合併後必須先編譯驗證了再提交。

9、通用配置和常用功能

git的使用尤其是多人合作,注意以下幾點:

1、推送伺服器前先同步;

2、兩個分支版本有衝突,先rebase解決,不熟練的情況下暫時不要使用merge;

3、版本節點不能使用中文,修改描述可以,關於修改描述的規範見下一章;

4、編譯自動生成的臨時檔案不要提交,可以使用tortoisegit–>delete and add in ignore list,可過濾指定的檔案,即使有改動也不提交;

5、git自帶的比較工具比較差,可以配置使用外部比較工具。

一共三處,將diff viewer和merge tool改為ha-bcompare。

這個工具的比較功能強大,顯示介面清晰。

為保證問題跟蹤方便,歷史修改記錄溯源,首次提交前必須設定使用者名稱和郵箱,尤其是使用者名稱,必須使用自己名字的小寫全拼,不得使用簡稱或者特殊代號。

功能接近的專案,盡量使用功能巨集或者專案巨集,從軟體原始碼上減少分支;

分支名稱使用大寫字母和下劃線,不能包含空格或中文;

臨時測試或驗證某個功能的分支,必須以test_開頭,驗證無誤,且應用到正式專案後,最好刪除遠端分支;

某個版本基礎上小改動,為解決生產或者客戶問題的版本,必須以patch_開頭,表示當前分支只是特殊情況下使用,後續正式版本不再繼續維護公升級;

因為需求變更,原***專案不得不分成2個分支,分支命名為***_aa和***_bb,其中aa和bb是兩個分支的主要區別關鍵字,前面一樣,表示兩分支原屬於同乙個分支節點;若後續***_bb繼續拆分,則新分支為***_bb_cc和***_bb_dd,依次類推;

禁止使用***1 ***2 ***3 這種分支名,禁止設分支名為master。

個人測試或者reabse前的遠端分支,原作者確認已經不再需要的,必須刪除遠端分支,簡化版本分支樹形結構。

[type] message

每行內容不超過50字, type 用於指定提交的 commit 的類別,只允許以下幾個動詞原語:

release 發布軟體時使必須有,且在第一行,後面內容是版本號

add 新增加的功能 fix 修復某個 bug 的描述

update 公升級完善原有的基礎功能上

change 需求變更或者實現的方案改變

docs 更新文件

test 增加/修改測試示例**

merge/rebase在解決**衝突,合併分支時使用

create 初次建立新專案時使用

remove 刪減**時使用

patch 整合合併sdk補丁

message 用於指定提交的描述文字,需要注意幾個事項。

1、使用中文表述,描述簡潔,抓住重點,尤其對修復的問題點

2、盡量以動詞開頭,如:更新,增加,修復等

3、特別複雜的功能或流程,可描述參考某文件,並更新上傳說明文件,

正確的示例:

[release] 發布v1.0.0_2021

[fix] 修復登入框顯示陰影的問題

[update] 優化rfid卡資訊讀取的驅動。

[test] 新增解碼gnss測試功能

[remove] 刪除多餘的提示框介面相關**

錯誤的示例:

[fix] 修復乙個大 bug //具體是什麼問題?

新增聯網模組 //沒有 type [add] [add]

更新 api 文件介面說明 // type錯誤,應該是[doc]

[release] v1.0_20210220 // release必須在第一行

工欲善其事必先利其器,工具的熟練掌握、合理利用,修改記錄儲存完整,後期檢索跟蹤問題,以及多專案軟體切換合併才能簡單易操作,才能保證**的質量。

使用說明 附註工具使用說明

附註工具使用說明 附註工具用途 附註工具主要用於更新利用word附註應用程式生成的帶域 的附註,該工具在word右鍵 更新鏈結 的基礎上進行了優化,故在使用時,不能再利用word右鍵 更新鏈結 而要用本工具的 更新當前鏈結 或 更新所有鏈結 使用說明 一 更換路徑 當利用word附註應用程式生成帶域...

git 使用說明

head代表當前 最新狀態。tag為某個狀態的標籤。sha1為每個提交日誌的唯一標識。install apt get install git core git clone git 倉 庫可以使用 git clone獲得 git clone git git longene.org unifiedker...

git使用說明

linus為linux kernel project發起的版本控制專案。head代表當前最新狀態。tag為某個狀態的標籤。sha1為每個提交日誌的唯一標識。install apt get install git core git clone git倉庫可以使用git clone獲得 git clon...