返回介绍

PR 合并方针

发布于 2024-06-22 20:04:58 字数 1445 浏览 0 评论 0 收藏 0

对 Flarum 源代码的技术性贡献需要经过审查流程。 多年来,我们依据我们的经验、我们目标明确的开发速度和可得性来调整这一流程。

什么造就了优秀的 Pull Request?

优秀的 Pull Requests:

  • 在发起 pull request 时,完整填写 Pull Request 模板
  • 不合并不同的更改。 不要修改无关代码的格式,即使它很有吸引力。 专注于你想贡献的单一功能或变更。
  • 有一个相关的已被核心团队认可的技术实行方案的 issue,或者该技术实行方案已经被核心团队通过官方论坛的讨论或类似于 Discord 的其他渠道同意。
  • 清楚地解释此更改的必要性并列出此 pull request 需要讨论的地方。

执行审查标准

  • 遵循我们的公约或者可以轻松地在合并后修补,遵循适当的代码风格。
  • 是否有任何实行细节可以通过替代技术/技术办法做得更好?
  • 不触及预定更改之外的任何行,例如通过格式化或编译。
  • 如果修改了公共 API 代码,是否有适当的文档部分?

合并时间!

如果符合所有模板中的检查,任何核心开发者都可以合并这个 PR。 如果此 PR 由一名核心开发者编写,他们可能是合并它的人。

  • 合并:

    • GitHub 提供了合并 PR 的几种方式。 在以下策略中选择:
      • 当 PR 分支由单个的描述细致的提交组成,并且适合出现在版本列表中,选择 Merge
      • 当积攒了大量提交时,Squash 是个好选择。 请务必按照 Conventional Commits 规范来 squash 提交。 我们通常会在这些预制的提交信息中发现一些来自StyleCI等机器人的提交,他们的提交信息应该被删除。
  • 在合并之后:

    • 将相关的 issue(如果没有,则是 pull request 本身,但绝不是两者同时)分配给适当的里程碑。
    • 关闭所有相关 issue(它们是否被全部关闭)。
    • 回归应按此标明,并在合并后从项目板和里程碑中删除。
    • 检查后续任务:
      • 合并相关的 PR(语言文件、扩展、文档)。
      • 更新文档。
    • 如有必要,为进一步的后续任务创建一个 issue。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文