贡献者指南

感谢您帮助改进 Cordova！本页提供有关如何为 Cordova 做出贡献的通用指南。如果您在本页上找不到任何内容，请随时联系开发邮件列表或在Cordova Slack上提问。

先决条件

在为 Apache Cordova 做出贡献之前，建议您加入邮件列表并简要介绍自己。

处理问题

所有 Apache Cordova 组件的问题都位于GitHub上。报告问题时，请遵循这些指南。

认领问题

如果您发现您想解决的问题，您可以要求认领它；请发表评论表明您的意图，提交者会将问题分配给您。如果很明显某个问题没有被处理，您可以自行处理（但请先评论告知受让人）。

提交代码

您可以通过在 Apache Github 镜像的 github.com/apache/<仓库名称> 提交拉取请求来提交代码。

创建拉取请求

在 Github 上创建拉取请求的工作流程通常遵循以下步骤

1. 如果尚未创建，则打开一个问题（可选）
2. 创建适当的 Cordova 存储库的本地 Fork
3. 在您的本地 Fork 中，创建一个专门用于您正在处理的问题的分支
4. 将您的提交推送到此分支
5. 压缩这些提交为一个单独的提交（请参阅下面关于提交消息的部分）
6. 在 Cordova 存储库上创建拉取请求
7. 请求代码审查

请在提交到 Github 的任何拉取请求的标题中包含问题 ID。有关 Git 的更多帮助，请参阅Git 文档。

代码审查

无论您如何提交代码，您都应该始终请求审查员查看并合并您的代码。GitHub 会很有帮助地建议您可以添加的潜在审查员，或者您可以向开发邮件列表发送一封邮件，其中包含指向拉取请求的链接。

测试您的代码

您负责在提交拉取请求之前测试您的更改并纠正任何问题。测试包括验证添加/触及的功能，以及运行测试套件以验证没有回归。

当我们说“运行测试套件”时，这包括

• cordova-mobilespec 中的所有自动化测试
• cordova-mobilespec 中可能受更改影响的手动测试
• 用于 JS 代码检查的 npm test
• 任何特定于平台的单元测试
  • cordova-android：npm run test-build
  • cordova-ios：npm test
  • cordova-js：jake test
  • cordova-plugman：npm test

请在问题中添加一条评论，说明您对更改所做的测试，以便提交者可以了解在合并之前进行了哪些测试。

添加测试

如果可能，请包含验证您的更改并捕获任何未来回归的测试。大多数存储库都有一个 tests/ 目录，其中包含该组件的测试。

Git 提交消息

在贡献时，请在您的提交消息开头包含问题 ID（如果存在）和相关平台（如果适用），后跟提交的描述。GitHub 上的问题 ID 应以 GH- 为前缀，这将允许 GitHub 自动链接问题和 PR。

GH-2345 android: Improved exec bridge by using strings instead of JSON
GH-3456 all: Fixed plugin loading paths that start with /

强烈建议您详细描述您的 git 提交，以便其他人能够理解它。这样做时，您的提交消息可以包含多行。但是，也强烈建议您的提交消息的第一行不超过 50 个字符。这是因为一些位于 git 之上的工具（例如允许您浏览存储库的 httpd 应用程序）假设第一行是顶级摘要，不超过 50 个字符。因此，将使用这些假设突出显示和截断提交消息，如果这些假设没有保持，它看起来会很奇怪。摘要和任何进一步的描述之间也应该有一个空行。例如，这是一个好的提交消息

GH-1234 Fixed the whizbang widget

- added more sanity checking in the build script.
- fixed the API to return the correct value in the scenario where there
  aren't any whizbangs present.
- corrected the documentation.

作为项目符号列表的替代，您可以在此处以段落形式放置长文本，每行包装在 72 个字符处，并且段落之间有空行。