是否可以在Github中为拉取请求创建自动模板？

Question

我想创建一个自动出现在每个拉取请求上的模板。

这可以是笔记或评论。理想情况下，它会显示检查拉取请求的指南：

- [ ] Have you done x?
- [ ] Have you done y?
- [ ] Have you done z?

有人可以建议这样做吗？

Answer 1

是的，现在可以。

将名为pull_request_template.md的文件添加到项目的根目录：

- [ ] Have you done x?
- [ ] Have you done y?
- [ ] Have you done z?

您还可以使用相同的约定为问题创建模板。只需将文件命名为issue_template.md。

来源：https://github.com/blog/2111-issue-and-pull-request-templates

Answer 2

GitHub不允许您为在其网站上创建的拉取请求创建模板。

我们使用的解决方案是通过hub命令使用github api创建拉取请求。我们将它包装在一个名为makePR的脚本中，该脚本执行如下操作：

#!/bin/bash
URL=$(hub pull-request -F PR-template.md)
echo "New PR created at $URL"
open $URL

（未经测试 - 我们的实际脚本做得更多 - 我已经遗漏了我认为你不需要的参数）

open命令将在MacOS的默认浏览器中打开URL，您可能需要为其他平台调整此值。打开后，您可以在Web浏览器中编辑标题。

Answer 3

GitHub现在通过PULL_REQUEST_TEMPLATE.md文件支持拉取请求模板

https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

Answer 4

不幸的是，单独使用GitHub是不可能的。好消息，GitHub现在支持这个！看看接受的答案。

此外，GitHub有一个非常酷（并且有点隐藏）的功能，您可以使用它在创建新问题或拉取请求时将潜在贡献者链接到某些贡献信息。

来自Contributing Guidelines上的The Github Blog：

  

我们已经尝试过让每个人都这么容易。作为维护者，您所要做的就是在存储库的根目录中添加一个贡献文件（如果您正在使用Markdown，则为CONTRIBUTING.md）。然后，当贡献者创建问题或打开拉取请求时，我们将添加指向您文件的链接。

     

     

现在，只要您的合作者开始参与，他们就可以轻松找到您希望他们遵循的指南。

Answer 5

有一个Chrome扩展程序声称在此处执行此操作： https://github.com/sprintly/pull-request-template-chrome-extension

不幸的是，我无法让它工作，但代码看起来很简单，可以弄清楚并修复 - 我希望它是一个简单的东西，由于github或chrome被更新而破坏。

它似乎只允许您为每个github pull请求使用单个模板，而不是为当前存储库提取正确的模板。

Answer 6

现在可以为问题和拉取请求创建模板。可以在存储库根目录或ISSUE_TEMPLATE文件夹中的PULL_REQUEST_TEMPLATE或.github文件中进行描述。

您可以在https://github.com/blog/2111-issue-and-pull-request-templates

找到更多信息