代码审核流程

进球数

我们的审核流程有几个目标:

  • 确保高品质的代码,包括功能和可读性。
  • 发现错误,因为错误时有发生。
  • 保持一致的样式,以便轻松地开始在代码库的任何部分工作。

blockly-samplescore Blockly 中的所有代码都需要经过审核,无论代码是由社区贡献者还是 Blockly 团队成员编写。

作为审核者,我们希望与您一起尽可能地完善您的更改。 作为贡献者,我们要求您与我们交流,让我们审核并合并您的拉取请求。

流程

PR 审核流程分为几个阶段:

  1. 分配关系
  2. 反馈
  3. 说明
  4. 修订版本
  5. 重复
  6. 合并!

分配

当您的拉取请求传入时,Blockly 团队的待命成员会指派一位审核者。

系统会根据专业知识选择审核者,并会均匀分配工作量。

分配审核者可能需要几天时间,完成审核可能需要几天时间。不用担心,这是正常现象。

反馈

在反馈阶段,审核人员会对您的 PR 提出更改建议。 这些可能很简单,可让您的代码符合 Google JavaScript 样式指南。或者,它们也可能是更大的事情,例如要求您重新组织函数定义。

我们建议审核者使用 GitHub 的代码审核(而不是单独发表评论),这样您就可以收到一条而不是多条通知。

讨论

讨论阶段是您回应反馈的机会。也许有一条评价意见不够清楚:现在您可以寻求澄清说明了。或者,您的审核者可能请求了更改,但您认为它会产生后果:现在是您找到折衷方案的机会。

修订版本

修订阶段是更改您的 PR 的阶段。通常,这些更改是审核人员在反馈阶段的陈述导致的。

完成修订版本后,不妨标记审核者,让他们再次查看。

重复

修订阶段后,审核人员再次有机会提供反馈,此过程会从头开始。

通常,第二次审核比较简单,重点关注标点符号和代码样式等细节。但有时,第二次审核可能会非常费力。第一位评价者甚至可能会请其他人进行审阅,以获得新鲜的视角。

合并!

在合并阶段,您将有机会庆祝。您已经创建了一个更改,讨论和修改它,并最终合并了它!这是许多人从来没有开始的伟大成就,更不用说完成了!

感谢您为完善 Blockly 所做的所有努力。恭喜!