贡献者指南

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

先决条件

在为 Apache Cordova 做出贡献之前，建议您加入 邮件列表 并发送简短的自我介绍。

处理问题

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

认领问题

如果您发现您想处理的问题，您可以请求认领它；请留下评论表明您的意图，提交者会将其分配给您。如果很明显某个问题没有得到处理，请随时自行处理（但请先评论以告知被分配者）。

提交代码

您可以通过在 Apache Github 镜像之一（github.com/apache/<repo name>）上提交拉取请求来提交代码。

创建拉取请求

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

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

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

代码审查

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

测试您的代码

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

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

• cordova-mobilespec 中的所有自动化测试
• cordova-mobilespec 中可能受更改影响的手动测试
• npm test 用于 JS 代码风格检查
• 任何特定于平台的单元测试
  • 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 个字符，段落之间留空行。