Skip to main content

介绍 electron/rfcs

· 5 min read

Electron 的 API 工作组 正在采用开放的 征求意见稿 (RFC) 进程,以帮助指导对 Electron 核心的较大更改。

🌐 Electron’s API Working Group is adopting an open Requests for Comments (RFC) process to help shepherd larger changes to Electron core.

为什么要发布 RFC?

🌐 Why RFCs?

简而言之,我们希望简化 Electron 核心重大变更的落地进程。

🌐 In short, we want to smooth out the process of landing significant changes to Electron core.

目前,新的代码更改主要通过 GitHub 上的问题和拉取请求进行讨论。对于大多数 Electron 的更改来说,这是一个很好的系统。许多错误修复、文档更改,甚至新功能都足够简单,可以通过标准的 GitHub 进程异步进行审查和合并。

🌐 Currently, new code changes are mostly discussed through issues and pull requests on GitHub. For most changes to Electron, this is a good system. Many bug fixes, documentation changes, and even new features are straightforward enough to review and merge asynchronously through standard GitHub flows.

对于更重大 的变更——例如,大型 API 接口或会影响大多数 Electron 应用的破坏性变更——在大部分代码编写之前在构思阶段进行审查是有意义的。

🌐 For changes that are more significant—for instance, large API surfaces or breaking changes that would affect the majority of Electron apps—it makes sense for review to happen at the ideation stage before most of the code is written.

这个进程旨在向公众开放,这也将使广大开源社区更容易在这些潜在更改进入 Electron 之前提供反馈。

🌐 This process is designed to be open to the public, which will also make it easier for the open source community at large to give feedback on potential changes before they land in Electron.

它是如何工作的?

🌐 How does it work?

整个 RFC 进程都保存在 GitHub 上的 electron/rfcs 仓库中。具体步骤在该仓库的 README 中有详细说明。

🌐 The entire RFC process lives in the electron/rfcs repository on GitHub. The steps are described in detail in the repository README.

简而言之,当对 electron/rfcs 仓库提出 PR 时,RFC 会被标记为已提出。 已提出的 RFC 会变为:

🌐 In brief, an RFC is Proposed once a PR is made to the electron/rfcs repository. A Proposed RFC becomes:

  • 活跃 当 PR 被合并到仓库的 main 分支时,这意味着 Electron 维护者对在 electron/electron 中的实现是认可的,或者
  • 拒绝 如果该合并请求最终被驳回。
info

为了使 RFC 成为 活跃 状态,PR 必须得到至少 2 名 API 工作组成员的批准。在合并之前,RFC 应该同步展示,并获得至少三分之二工作组成员的法定人数一致通过。如果达成共识,将启动为期一个月的最终评论期,之后 PR 将被合并。

🌐 For the RFC to become Active, the PR must be approved by at least 2 API Working Group members. Before merging, the RFC should be presented synchronously and accepted unanimously by a quorum of at least two-thirds of the WG members. If consensus is reached, a one-month final comment period will be triggered, after which the PR will be merged.

如果实现已合并到 electron/electron,则活动 RFC 被视为完成

🌐 An Active RFC is Completed if the implementation has been merged into electron/electron.

谁可以参与?

🌐 Who can participate?

Electron 社区中的任何人都可以提交 RFC 或在 electron/rfcs 仓库中留下反馈!

🌐 Anyone in the Electron community can submit RFCs or leave feedback on the electron/rfcs repository!

我们希望将这一进程变成双向对话,并鼓励社区参与,以便从未来可能使用这些 API 的 Electron 应用中获得多样化的意见。如果你有兴趣对当前提议的 RFC 提出反馈,Electron 维护者已经创建了一些供参考:

🌐 We wanted to make this process a two-way dialogue and encourage community participation to get a diverse set of opinions from Electron apps that might consume these APIs in the future. If you’re interested in leaving feedback on currently proposed RFCs, the Electron maintainers have already created a few:

致谢

🌐 Credits

Electron 的 RFC 进程是以许多成熟的开源 RFC 进程为模型的。许多想法和主要文案的灵感来源于:

🌐 Electron's RFC process was modeled on many established open source RFC processes. Inspiration for many ideas and major portions of copywriting go to: