【问题标题】:Is it possible to create an automatic template for pull requests in Github?是否可以在 Github 中为拉取请求创建自动模板?
【发布时间】:2023-03-29 19:05:01
【问题描述】:

我想创建一个模板,它会自动出现在每个拉取请求中。

这可以是注释或评论。理想情况下,它将显示有关审查拉取请求的指南:

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

任何人都可以建议这样做的方法吗?

【问题讨论】:

标签: github


【解决方案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

【讨论】:

  • 看来模板必须在项目的默认分支中才能使用。例如,假设默认分支是master,但你想做一个从some_featurebeta 的PR。启动 PR 后,界面显示 PR 转到master。如果您的模板在master 中,它将被使用,但如果它在beta 中,则不会使用它,即使您更改了 PR 库的选择。
  • 模板也可以进入.github/文件夹,避免根目录混乱
【解决方案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,您可能需要针对其他平台进行调整。打开后,您可以在网络浏览器中编辑标题。

【讨论】:

  • 这个答案已经过时了。
  • @ThomasW 这个简单的版本已经过时了,但真正的版本在 PR 描述中插入了更多动态的东西,这取决于分支的名称,包括指向 JIRA 等问题的链接。
  • 我应该说,第一句话已经过时了。
【解决方案3】:

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

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

【讨论】:

    【解决方案4】:

    很遗憾,仅靠 GitHub 无法做到这一点。 好消息,GitHub 现在支持了!查看接受的答案。

    此外,GitHub 有一个非常酷(而且有些隐蔽)的功能,您可以在潜在贡献者创建新问题或拉取请求时将其链接到某些贡献信息。

    来自Contributing GuidelinesThe Github Blog

    我们已尝试让每个人都能轻松完成这项工作。作为维护者,您所要做的就是将 CONTRIBUTING 文件(或 CONTRIBUTING.md,如果您使用 Markdown)添加到存储库的根目录。然后,当贡献者创建问题或打开拉取请求时,我们将添加指向您文件的链接。

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

    【讨论】:

      【解决方案5】:

      有一个 chrome 扩展程序声称在这里可以做到这一点: https://github.com/sprintly/pull-request-template-chrome-extension

      不幸的是,我无法让它工作,但代码看起来很简单,可以找出并修复 - 我希望它是由于 github 或 chrome 更新而损坏的简单代码。

      它似乎只允许您为每个 github 拉取请求使用一个模板,而不是为当前存储库拉入正确的模板。

      【讨论】:

      【解决方案6】:

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

      您可以在这里找到更多信息https://github.com/blog/2111-issue-and-pull-request-templates

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 2018-04-15
        • 2022-12-30
        • 1970-01-01
        • 1970-01-01
        • 2014-12-24
        • 1970-01-01
        • 1970-01-01
        • 2019-01-03
        相关资源
        最近更新 更多