Skip to main content

electron/rfcs 介绍

· 6 min read
erickzhao

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 中的实现，或者

    ¥Active when the PR is merged into the main branch of the repository, which means that Electron maintainers are amenable to an implementation in electron/electron, or

  • 如果 PR 最终被拒绝，则拒绝。

    ¥Declined if the PR is ultimately rejected.

信息

要使 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: