跳到主要内容

如何贡献代码

感谢您对为 React Native 做出贡献的兴趣！从评论和分诊 issue，到审查和发送 PR，我们欢迎所有贡献。在本文档中，我们将介绍为 React Native 贡献代码的步骤。

如果您渴望立即开始贡献代码，我们有一个 good first issues 列表，其中包含范围相对有限的错误。标记为 help wanted 的 issue 非常适合提交 PR。

先决条件​

信息

请参考 环境搭建 指南，根据您使用的平台和您要开发的平台设置所需的工具和开发环境。

开发工作流程​

克隆 React Native 后，打开目录并运行 yarn 安装其依赖项。

现在您可以运行以下几个命令

  • yarn start 启动 Metro 打包服务器。
  • yarn lint 检查代码风格。
  • yarn format 自动格式化您的代码。
  • yarn test 运行基于 Jest 的 JavaScript 测试套件。
    • yarn test --watch 运行交互式 JavaScript 测试监视器。
    • yarn test <pattern> 运行文件名匹配的 JavaScript 测试。
  • yarn flow 运行 Flow 类型检查。
    • yarn flow-check-android 对 *.android.js 文件执行完整的 Flow 检查。
    • yarn flow-check-ios 对 *.ios.js 文件执行完整的 Flow 检查。
  • yarn test-typescript 运行 TypeScript 类型检查。
  • yarn test-ios 运行 iOS 测试套件 (需要 macOS)。
  • yarn build 构建所有配置的包 — 通常，此命令只需要在发布前由 CI 运行。

测试您的更改​

测试帮助我们防止将回归引入代码库。我们建议运行 yarn test 或上面的平台特定脚本，以确保在您进行更改时不会引入任何回归。

GitHub 仓库使用 CircleCI 进行持续测试，其结果可通过 commits 和 pull requests 上的 Checks 功能查看。

您可以在 如何运行和编写测试 页面了解有关运行和编写测试的更多信息。

编码风格​

我们使用 Prettier 格式化我们的 JavaScript 代码。这可以节省您的时间和精力，因为您可以让 Prettier 通过其编辑器集成自动修复任何格式问题，或者手动运行 yarn run prettier。我们还使用 linter 来捕获代码中可能存在的样式问题。您可以通过运行 yarn run lint 来检查代码样式的状态。

但是，仍然有一些 linter 无法识别的样式，尤其是在 Java 或 Objective-C 代码中。

Objective-C​

  • @property 声明后的空格
  • 每个 if 语句的括号，在同一行
  • - method、@interface 和 @implementation 的括号在下一行
  • 尽量保持在 80 个字符的行长左右（有时不可能...）
  • * 运算符与变量名在一起（例如 NSObject *variableName;）

Java​

  • 如果方法调用跨越多行，则右括号与最后一个参数在同一行。
  • 如果方法头不适合放在一行，则每个参数都放在单独的一行。
  • 100 个字符的行长

发送 Pull Request​

对 React Native 的代码级贡献通常以 pull request 的形式出现。向 React Native 提议更改的过程可以总结如下

  1. Fork React Native 仓库并从 main 创建您的分支。
  2. 如果您添加了应该测试的代码，请添加测试。
  3. 如果您更改了 API，请更新文档。
  4. 确保测试套件通过，无论是在本地还是在您发起 pull request 后在 CI 上。
  5. 确保您的代码通过 linter 检查（例如通过 yarn lint --fix）。
  6. 将更改推送到您的 fork。
  7. 创建一个 pull request 到 React Native 仓库。
  8. 审查并解决您 pull request 上的评论。
  9. 机器人可能会评论并提出建议。通常，我们要求您先解决这些问题，然后再由维护人员审查您的代码。
  10. 如果您还没有提交 贡献者许可协议 (CLA)，请提交。

如果一切顺利，您的 pull request 将被合并。如果未被合并，维护人员将尽力解释原因。

如果这是您第一次发送 pull request，我们创建了一个 分步指南 来帮助您入门。有关如何处理 pull request 的更详细信息，请参阅 Pull Request 管理 页面。

贡献者许可协议​

为了接受您的 pull request，我们需要您提交 贡献者许可协议 (CLA)。您只需执行一次此操作即可参与 Meta 的任何开源项目。这只需一分钟，因此您可以在等待依赖项安装时完成。

许可​

通过为 React Native 做出贡献，您同意您的贡献将根据 React Native 仓库根目录中的 LICENSE 文件获得许可。