--- # System prepended metadata title: Git 使用建議 tags: [Git] --- ###### tags: `Git` Git 使用建議 =========== > 小弟之前有花蠻多時間研究 Git 的操作及用法，略有一些心得，提出一些建議供各位參考: ## 1. Git commit message ### Message 撰寫相關資訊建議: - 第一行為標題/主題(subject)，盡量不要超過 50 個字元，內容簡單一句話帶過但需包含修改重點 - 標題開頭為類別 - 標題不以句點結尾 - 第二行為==一個空白行==, 空白行分隔標題與內容 - 第三行為內文，每行建議 72 字以內 - 內文解釋至少包含 why、how ### Format ``` :<空格><空格> //空一行 <--! 修改內容描述開始 --> 原因(why): 調整項目(how): <--! 修改內容描述結束 --> ``` ### Type 類別定義 * Feature * Docs * UI * Barcode * FPGA * CnvEngine ... ::: warning 需討論Fucntion 的分類 ::: ### Action 定義 * add (新增;addition) * mod (修改;modify) * rev (修正;Revise) * del (刪除;delete) * refactor (重構) ### Example: ``` = UI: 修改 Qt 內建 Dialog 物件使用 Page 改寫原因: 由於虛擬鍵盤的　page scoll 功能只能在page component 使用, 若 Dialog 內建包含 Inputbox/Textfield 物件,開啟鍵盤將會擋住該物件,看不到輸入的數值. 調整項目: 1. 改寫 DialogBase.qml 2. 修改所有引用 DialogBase 物件的qml 檔 issue #1234 ``` ### 建立 reopsitory 共用的 "git commit meassge template" 檔案 ``` = vi .gitCommitTemplate/git-commit-template ``` 新增message 內容,例如: ``` = :<空格><空格> 原因: 1. 調整項目: 1. # issue #xxxx # type: # Feature # Docs # UI # Barcode # FPGA # CnvEngine # action: # add (新增;addition) # mod (修改;modify) # rev (修正;Revise) # del (刪除;delete) # refactor (重構) ``` ::: info "#" 開頭為註解, git commit時, "#" 開頭那一行不會被當成訊息資訊 ::: Syntax: ``` = git config --global commit.template <.git-commit-template file path> ``` example: ``` = git config --global commit.template .gitCommitTemplate/git_commit_template ``` ### 建立 message hooks (具強制性) * 使用 Aangular Js 的 git hook script ``` python = #!/usr/bin/env python """ Git commit hook: .git/hooks/commit-msg Check commit message according to angularjs guidelines: * https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit# """ import sys import re valid_commit_types = ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore', ] commit_file = sys.argv[1] help_address = 'https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#' with open(commit_file) as commit: lines = commit.readlines() if len(lines) == 0: sys.stderr.write("\nEmpty commit message\n") sys.stderr.write("\n - Refer commit guide: %s\n\n" % help_address) sys.exit(1) # first line line = lines[0] m = re.search('^(.*)$(.*)$: (.*)$', line) if not m or len(m.groups()) != 3: sys.stderr.write("\nFirst commit message line (header) does not follow format: type(scope): message\n") sys.stderr.write("\n - Refer commit guide: %s\n\n" % help_address) sys.exit(1) commit_type, commit_scope, commit_message = m.groups() if commit_type not in valid_commit_types: sys.stderr.write("\nCommit type not in valid ones: %s\n" % ", ".join(valid_commit_types)) sys.stderr.write("\n - Refer commit guide: %s\n\n" % help_address) sys.exit(1) if len(lines) > 1 and lines[1].strip(): sys.stderr.write("\nSecond commit message line must be empty\n") sys.stderr.write("\n - Refer commit guide: %s\n\n" % help_address) sys.exit(1) if len(lines) > 2 and not lines[2].strip(): sys.stderr.write("\nThird commit message line (body) must not be empty\n") sys.stderr.write("\n - Refer commit guide: %s\n\n" % help_address) sys.exit(1) sys.exit(0) ``` * 使用 commitlint * https://github.com/conventional-changelog/commitlint * 使用validate-commit-msg https://github.com/conventional-changelog-archived-repos/validate-commit-msg ### 自動生成 changelog file 若 Commit 符合 [Angular 所定義的格式](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#),可使用以下工具自動產生CHANGELOG.md: :::info ==Angular Format:== ``` = ():