# 前言
紀錄如何利用 Git template 來管理並規範你的 git commit message
# 正文
# 建立
# 放到你喜歡的位置
cp .gitmessage.txt whereverYouLike
|
# 設定
如我想要這份模板的範圍是 global 的, 就使用 --global
, 若希望範圍只在某個專案, 就在該專案內使用下這行指令並使用 --local
git config --global commit.template ~/.gitmessage.txt
|
# template example
下面是我使用的模板 example, 團隊可自訂適用於該團隊的
# commit log 請遵造以下格式,並注意冒號後面有一個空格 # # <[type]>: <subject> {必要, 請參考下面的解說} # # <body> {非必要, 請參考下面的解說} # # <footer> {非必要, 請參考下面的解說} # # 範例: # [feat]: 實作 login api function # # 完成登入功能, 並串接 Line Login # # Closes OR-xxxx # # <Type> # 請遵守下列標籤 # feat: 新功能 # fix: Bug修復 # config: 設定檔改變 # docs: 文檔改變 # style: 代碼格式改變 # refactor: 功能重構 # perf: 性能優化 # test: 增加測試代碼 # build: 改變build工具 # ci: 與ci相關的設定 # add: 增加一些跟功能無關的檔案 # 3rd: 增加第三方 # db: 有關資料庫的修改 # # <Subject> # 用來簡要描述影響本次變動,概述即可 # # <Body> # 具體的修改訊息,越詳細越好 # # <Footer> # 如果是要關閉特定 Issue 或 Bug. 可以使用 Closes PROJECT-1 or Resolves PROJECT-1 or Fixes PROJECT-1 # 具體清參考 https://docs.gitlab.com/ee/user/project/integrations/jira.html
|
留言