跳至主要内容

Electron 开发

这些指南适用于从事 Electron 项目本身的人员。有关 Electron 应用程序开发的指南,请参阅 /docs/README.md.

目录

入门

为了为 Electron 贡献代码,您首先要做的就是获取代码。

Electron 的 build-tools 自动执行了从源代码编译 Electron 的大部分设置,并支持不同的配置和构建目标。

如果您更愿意手动构建 Electron,请参阅 构建说明.

检出并构建代码后,您可能希望查看源代码树,以更好地了解每个目录负责哪些内容。 源代码目录结构 提供了每个目录目的的概述。

在 Electron 上打开问题

对于任何问题,个人通常可以通过三种方式做出贡献

  1. 通过打开问题进行讨论
  2. 通过帮助进行问题分类
    • 您可以通过提供辅助细节(证明错误的可重现测试用例)或提供解决问题的建议来做到这一点。
  3. 通过帮助解决问题
    • 这可以通过证明问题不是错误或已解决来完成;但更常见的是,通过打开一个拉取请求,以具体且可审查的方式更改 electron/electron 中的源代码。

有关更多信息,请参阅 问题

向 Electron 发送拉取请求

针对 electron/electron 存储库打开的大多数拉取请求都包含对 shell/ 文件夹中的 C/C++ 代码、lib/ 文件夹中的 TypeScript 代码、docs/ 中的文档或 spec/ 文件夹中的测试的更改。

有关更多信息,请参阅 拉取请求

如果您想向 Electron 添加新的 API 模块,您需要查看 创建 API

治理

Electron 拥有一个完善的治理系统,负责监督 Electron 的活动,其工作组负责 API、发布和升级 Electron 的依赖项,包括 Chromium 和 Node.js。根据您希望贡献的频率和目的,您可能希望考虑加入工作组。

每个组的详细信息及其职责可以在 治理存储库 中找到。

Electron 中的补丁

Electron 基于两个主要的 上游 项目:Chromium 和 Node.js。这两个项目也有各自的几个依赖项。我们尽最大努力按原样使用这些依赖项,但有时我们无法在不修补这些上游依赖项以适应我们的用例的情况下实现我们的目标。

因此,我们在源代码树中维护了一组补丁。有关通过拉取请求将这些补丁中的一个添加到 Electron 源代码树中的过程,请参阅 补丁

调试

调试 Electron 中的问题和错误有许多不同的方法,其中许多是特定于平台的。

有关调试 Electron 本身(而不是用 Electron 构建的应用程序)相关信息的概述,请参阅 调试