- PR Title PR 標題的格式如下 ``` [PR 類型] PR 標題 ``` PR 類型包括如下 | 類型 | 範例 | | ------ | ------ | | BugFix | [BugFix] 修正某個壞掉的功能 | | HotFix | [HotFix] 緊急修正某個奇怪的東西 | | CS | [CS] 修正 Coding Style | | Feature | [Feature] 寫了某個新功能 | | Update | [Update] 改了某個文字檔 | | Refactor | [Refactor] 重構了某個功能 | 當 PR 有相對應的 issue 號碼時,建議加在 PR 類型後面,舉例如下 | PR 標題範例 | | ------ | | [Feature #90] 寫了某個新功能 | | [BugFix #119] 修正某個壞掉的功能 | - PR comment 有相關的 issue 時在 comment 內列出 範例如下: | PR comment 範例 | | ------ | | 修正 #123 | | Fixed #123 #107 | | 完成 #123 #90 | | Finish #123 #90 | | Finish #123 merge after #90 | | 完成 #123 在 #90 之後 merge | - close issue 關閉 issue 時請填寫關閉的理由 幾種關閉的理由列舉如下 | close issue comment example | | ------ | | closed by #123 | | 該 issue 已有結論 | | 該 issue 已結案 | - commit message (建議寫法,不強制規定) 有相關的 issue 時在 commit message 內列出 commit message 的格式如下 ``` commit message balabalba (issue #123) ``` 主要的規則是在原本的 commit message 後加上括號,括號內填寫 issue 的編號 範例如下: | commit message 範例 | | ------ | | Do something well (fixed #107) | | fixed the bug of the category counts (issue #123) | | complete feature balabala (for #123) | | complete feature balabala. for #123 | | 可自動關閉 issue 的語法統整 | | ------ | | fix #xxx | | fixes #xxx | | fixed #xxx | | close #xxx | | closes #xxx | | resolve #xxx | | resolves #xxx | | resolved #xxx |
PR Title
PR 標題的格式如下
PR 類型包括如下
當 PR 有相對應的 issue 號碼時,建議加在 PR 類型後面,舉例如下
PR comment
有相關的 issue 時在 comment 內列出
範例如下:
close issue
關閉 issue 時請填寫關閉的理由
幾種關閉的理由列舉如下
commit message (建議寫法,不強制規定)
有相關的 issue 時在 commit message 內列出
commit message 的格式如下
主要的規則是在原本的 commit message 後加上括號,括號內填寫 issue 的編號
範例如下: