我想为我的Github存储库(公司内部版本,而不是Github.com上的版本)创建自定义的Pull Requests模板,因此我按照此link上的说明进行操作。我遵循以下步骤:
创建新的PR不会显示我创建的模板。创建新问题模板的类似步骤可以正常工作,但PR模板无法正常工作。我想在PULL_REQUEST_TEMPLATE文件夹内添加不同的模板,以便创建多个拉取请求模板,例如功能模板,错误修复模板等。我的PR模板markdown包含以下内容:
---
name: Design Review
about: Design Review issue template
---
# PR Change Description
This PR is to add a new vendor type.
答案 0 :(得分:3)
默认情况下,GitHub将加载文件.github/PULL_REQUEST_TEMPLATE.md
作为PR模板。
但是,可以有多个模板,并使用URL上的查询字符串引用它们,如下所示:
https://github.com/octo-org/octo-repo/compare/master...pull-request-test?template=pr_template.md
这将从pr_template.md
加载模板.github/PULL_REQUEST_TEMPLATE/pr_template.md
,其中master
是目标分支,pull-request-test
是要合并的分支。
类似的问题
https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md
在这一点上,文档的编写不够好,但是PR创建表单的完整参数集在此处列出:https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters,但是对于该特定示例,它甚至具有错误的URL
对于问题,现在有一个通过yaml配置的模板选择器,因此您可以在不使用查询字符串的情况下在模板之间进行选择,也许稍后PR会出现类似的情况 https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository
答案 1 :(得分:2)
您必须在存储库的默认分支上创建模板。在其他分支中创建的模板不可供协作者使用。您可以将请求请求模板存储在存储库的可见根目录,docs文件夹或隐藏的.github目录中。拉取请求模板文件名不区分大小写,并且可以具有扩展名,例如.md或.txt。
答案 2 :(得分:0)
您应该只在.github
文件夹中创建文件,而不是PULL_REQUEST_TEMPLATE
文件夹中的文件。
将.md
文件移动到.github/PULL_REQUEST_TEMPLATE.md
应该可以。
答案 3 :(得分:0)
我尝试通过将pull_request_template.md
文件添加到.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
路径
但是它不起作用,然后我将文件移到.github/pull_request_template.md
路径,即删除了子目录PULL_REQUEST_TEMPLATE
并使其工作。
因此,如果您没有多个模板,则无需创建PULL_REQUEST_TEMPLATE
子目录,并确保在默认为pull_request_template.md
的默认分支中创建master
。 / p>