如何创建优秀的 Pull 请求模板（以及为什么要添加 GIF）

2008 年 GitHub 首次引入拉取请求 (PR) 时，我还没进入科技行业。四年前我从训练营毕业时，可能只创建过寥寥几条 PR。不过，当我开始在团队中从事第一份工作时，我很快就意识到 PR 的重要性。随着我作为维护者投入的时间越来越长，我对优质拉取请求的重视也与日俱增。

Pull 请求的优点在于，它允许贡献者和维护者之间进行协作，提供交流已做变更及其重要性的机会，并允许维护者提供反馈。由于贡献者的背景、经验和语言各不相同，创建优秀的 PR 有时会比较棘手。不过，有一些方法可以优化每个人的体验，例如添加动图。

如何创建拉取请求模板

维护人员可以通过创建模板来帮助改善审查 Pull 请求和贡献者提交请求的体验。

我喜欢将拉取请求模板视为一种贡献者入职培训。它有助于指导他们完成编写良好拉取请求并与维护者沟通的过程。虽然优秀的模板可能因不同的组织、其标准和需求而异，但您可以使用一些基本的清单来生成自己的模板。

要在 GitHub 中创建 PR 模板，请.github在存储库的根目录中创建一个文件夹和一个名为 的文件PULL_REQUEST_TEMPLATE.md。

在 OpenSauced，我们使用forem 的 Pull Request 模板来作为
我们模板的灵感。

您可以使用 markdown 创建模板，并包含如下部分：

• 这是什么类型的 PR？
• 变更描述
• 相关票据及文件
• 移动和桌面截图/录音
• 测试
• 文档
• 部署后任务
• 哪个 gif 最能描述这个 PR 或者它给你什么感觉？

让他们添加 Gif！

最后一点可能对你来说不太合适，但它实际上可以让公关体验更有趣、更吸引人、更高效。原因如下：

• Gif 可以弥合语言差距并帮助贡献者更清楚地表达自己。
• Gif 可以展示贡献者的个性并为 PR 增添个人风格。
• Gif 可以增加参与度并使每个人的审核过程更加愉快。

如何将 Gif 添加到你的 PR

如果您是贡献者，您可能会想：“添加 GIF 最简单的方法是什么？” 我使用的是 GitHub Chrome 扩展程序 GIFs。安装后，您就可以快速添加所有您喜欢的 GIF，以增强 PR 体验。只需搜索您想要的 GIF，然后点击它即可。您甚至可以添加标题来描述 GIF 或解释它与 PR 的关系 👏

您可以在@Brian Douglas 的帖子“如何在 GitHub 上让您的 Pull 请求获得审核的技巧”中了解更多关于 PR 的信息。或者，您也可以在OpenSauced 热门仓库中查看最热门的仓库以及它们如何处理 PR 。如果您有创建优秀 Pull 请求的技巧，请在下方评论区告诉我们。

使用midjourney创建的标题图像。