跳过主内容

如何贡献代码

感谢您对贡献 React Native 的兴趣！从评论和分类问题，到审查和发送 PR，所有贡献都受到欢迎。本文档将介绍向 React Native 贡献代码的步骤。

如果您渴望立即开始贡献代码，我们有一个good first issues 列表，其中包含范围相对有限的错误。标记为help wanted 的问题是适合提交 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 持续测试，其结果可通过 提交 和拉取请求的检查功能获取。

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

编码风格​

我们使用 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 字符行长度

提交拉取请求​

对 React Native 的代码级贡献通常以拉取请求的形式出现。向 React Native 提议更改的过程可概括如下

  1. Fork React Native 仓库并从 main 分支创建您的分支。
  2. 如果您添加了需要测试的代码，请添加测试。
  3. 如果您更改了 API，请更新文档。
  4. 确保测试套件通过，无论是在本地还是在您打开拉取请求后的 CI 上。
  5. 确保您的代码通过 lint 检查（例如通过 yarn lint --fix）。
  6. 将更改推送到您的 fork。
  7. 向 React Native 仓库创建拉取请求。
  8. 审查并处理您拉取请求中的评论。
  9. 机器人可能会提供建议。通常我们要求您先解决这些问题，然后维护者才会审查您的代码。
  10. 如果您尚未签署，请提交贡献者许可协议（“CLA”）。

如果一切顺利，您的拉取请求将被合并。如果未合并，维护者将尽力解释原因。

如果这是您第一次提交拉取请求，我们创建了一个分步指南帮助您入门。有关如何处理拉取请求的更多详细信息，请参阅管理拉取请求页面。

贡献者许可协议​

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

许可证​

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