git commit模板


1.使用git commit 模板

操作步驟

1.)設置模板路徑,其中path就是commit模板路徑
git config --global commit.template path
2.)設置模板使用什么軟件打開
git config --global core.editor [編輯器名字]

3.)commit模板

fix(<模塊>): <描述>

#<具體描述>

#<問題單號>

# type 字段包含:
# feat:新功能(feature)
# fix:修補bug
# docs:文檔(documentation)
# style: 格式(不影響代碼運行的變動)
# refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
# test:增加測試
# chore:構建過程或輔助工具的變動
# scope:用於說明 commit 影響的范圍,比如數據層、控制層、視圖層等等。
# subject:是 commit 目的的簡短描述,不超過50個字符
# Body:部分是對本次 commit 的詳細描述,可以分成多行
# Footer:用來關閉 Issue或以BREAKING CHANGE開頭,后面是對變動的描述、以及變動理由和遷移方法

使用示例:

(a.)在/home/xxx目錄下創建一個commit.template文件

vim commit.template
【模塊名稱】:
【修改描述】:
【問題/需求單號】:

(b.)設置模板路徑

git config --global commit.template /home/xxx/commit.template

(c.)設置編輯器

git config --global core.editor vim  //這里設置vim,也可以設置text,egit等其他編輯器

(d.)修改文件,執行

git add .  // 添加工作區的修改文件到緩存區
git commit   // 該命令會自動彈出如下彈框,只需編輯后面的內容即可
git push origin dev // 推送到遠端倉庫

2. gitlab merge 模板

(1.) 在項目的根目錄下創建目錄:

.gitlab/merge_request_templates

(2.)在上述目錄中添加模板,文件需要為md格式,如:

fixbugs-template.md  //修改bugs模板
feature-template.md  //新增特性模板

(3.)模板內容參考

【bugs單號】: xxx
【問題原因】:xxx
【修改描述】: 本次提交修改了xxx問題
【修改時間】:2020-11-19
【修改人】:xx

(4.)合並時選擇對應的模板


免責聲明!

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



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