摘要：在GitHub代碼庫中，引入代碼庫維護(hù)者定制的 issues 模版和 pull request 模版，讓人們可以有針對性的提供某類問題的準(zhǔn)確信息葡公，從而在后續(xù)維護(hù)中能夠進(jìn)行有效地對話和改進(jìn)彼水，而不是雜亂無章的留言。
一幸缕、issues 模版
1.1 默認(rèn)模版
- 在代碼庫新建目錄：
.github - 在
.github目錄下添加ISSUE_TEMPLATE.md文件作為 issues 默認(rèn)模版群发。當(dāng)創(chuàng)建 issue 時(shí)，若未建立多模版或選擇了Open a regular issue時(shí)发乔，系統(tǒng)會引用該模版熟妓。
引用默認(rèn)模版
1.2 多模版
- 在代碼庫新建目錄：
.github/ISSUE_TEMPLATE - 該目錄下可添加多個(gè)
.md文件作為 issues 模版。當(dāng)創(chuàng)建 issue 時(shí)栏尚，系統(tǒng)會展示這些模版供選擇起愈。 -
.md文件參考格式如下：
---
name: 該模版的名稱（創(chuàng)建 issue 時(shí)，系統(tǒng)展示模版列表時(shí)會顯示該名稱）
about: 該模版的描述（創(chuàng)建 issue 時(shí)，系統(tǒng)展示模版列表時(shí)會顯示該描述）
---
正文內(nèi)容……
1.3 注意事項(xiàng)
- issues 的默認(rèn)模版和多模版可同時(shí)存在告材。
- 關(guān)于 issues 模版的描述可詳見幫助文檔：https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/
二坤次、pull request 模版
2.1 默認(rèn)模版
- 在代碼庫新建目錄：
.github - 在
.github目錄下添加PULL_REQUEST_TEMPLATE.md文件作為 pull request 默認(rèn)模版。當(dāng)創(chuàng)建不帶參數(shù)的 pull request 時(shí)斥赋，系統(tǒng)會引用該模版缰猴。
2.2 多模版
- 在代碼庫新建目錄：
.github/PULL_REQUEST_TEMPLATE - 該目錄下可添加多個(gè)
.md文件作為 pull request 模版。 - pull request 模版要通過查詢參數(shù)來調(diào)用疤剑。例如滑绒，要使用
pr-template-1.md這個(gè)模版，可使用如下查詢：
https://github.com/用戶名/代碼庫名稱/compare/分支名稱?expand=1&template=pr-template-1.md
或參考GitHub幫助文檔的格式隘膘，如下疑故。兩者效果相同。
https://github.com/用戶名/代碼庫名稱/compare/master...分支名稱?expand=1&template=pr-template-1.md
- 可選查詢參數(shù)
-
expand=1弯菊，直接跳轉(zhuǎn)到 pull request 界面纵势。如果不帶此參數(shù)會先到 compare 界面，需手動進(jìn)入pull request 界面管钳。 -
template=pr-template-1.md钦铁，調(diào)用名為pr-template-1.md的模版。如果不帶此參數(shù)才漆，則調(diào)用默認(rèn)模版牛曹。 -
title=New+bug+report（或者title=New%20bug%20report），指定 pull request 的標(biāo)題為New bug report - 其他參數(shù)可詳見幫助文檔：https://help.github.com/articles/about-automation-for-issues-and-pull-requests-with-query-parameters/
-
2.3 注意事項(xiàng)
- pull request 的默認(rèn)模版和多模版可同時(shí)存在醇滥。
- 關(guān)于 pull request 模版的描述可詳見幫助文檔：https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/
