GitHub中使用 issues 模版和 pull request 模版

摘要： 摘要：在GitHub程式碼庫中，引入程式碼庫維護者定製的 issues 模版和 pull request 模版，讓人們可以有針對性的提供某類問題的準確資訊，從而在後續維護中能夠進行有效地對話和改進，而不是雜亂無章的留言。 一、issues 模版 1.1 預設模版 在程式碼...

摘要：在GitHub程式碼庫中，引入程式碼庫維護者定製的 issues 模版和 pull request 模版，讓人們可以有針對性的提供某類問題的準確資訊，從而在後續維護中能夠進行有效地對話和改進，而不是雜亂無章的留言。

一、issues 模版

1.1 預設模版

• 在程式碼庫新建目錄： .github
• 在 .github 目錄下新增 ISSUE_TEMPLATE.md 檔案作為 issues 預設模版。當建立 issue 時，若未建立多模版或選擇了 Open a regular issue 時，系統會引用該模版。

1.2 多模版

.github/ISSUE_TEMPLATE
.md
.md

---
name: 該模版的名稱（建立 issue 時，系統展示模版列表時會顯示該名稱）
about: 該模版的描述（建立 issue 時，系統展示模版列表時會顯示該描述）
---

正文內容……

1.3 注意事項

• issues 的預設模版和多模版可同時存在。
• 關於 issues 模版的描述可詳見幫助文件： ofollow,noindex">https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/

二、pull request 模版

2.1 預設模版

• 在程式碼庫新建目錄： .github
• 在 .github 目錄下新增 PULL_REQUEST_TEMPLATE.md 檔案作為 pull request 預設模版。當建立不帶引數的 pull request 時，系統會引用該模版。

2.2 多模版

.github/PULL_REQUEST_TEMPLATE
.md
pr-template-1.md

https://github.com/使用者名稱/程式碼庫名稱/compare/分支名稱?expand=1&template=pr-template-1.md
或參考GitHub幫助文件的格式，如下。兩者效果相同。
https://github.com/使用者名稱/程式碼庫名稱/compare/master...分支名稱?expand=1&template=pr-template-1.md

• 可選查詢引數
  • expand=1 ，直接跳轉到 pull request 介面。如果不帶此引數會先到 compare 介面，需手動進入pull request 介面。
  • template=pr-template-1.md ，呼叫名為 pr-template-1.md 的模版。如果不帶此引數，則呼叫預設模版。
  • title=New+bug+report （或者 title=New%20bug%20report ），指定 pull request 的標題為 New bug report
  • 其他引數可詳見幫助文件： https://help.github.com/articles/about-automation-for-issues-and-pull-requests-with-query-parameters/

2.3 注意事項

• pull request 的預設模版和多模版可同時存在。
• 關於 pull request 模版的描述可詳見幫助文件： https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/