我们欢迎并感谢所有对 Capgo 的贡献。

本页面作为帮助您开始贡献的工具。

项目

在组织中有许多仓库是 __CAPGO_KEEP_0__ 生态系统的一部分。 Capgo organization that are part of the Capgo ecosystem.

为了帮助您决定哪个仓库可能是最好的开始贡献的仓库（并且符合您的兴趣），以下是仓库的简要比较（<strong>使用粗体的语言占据了代码库的大部分</strong>）：

这是提供主插件的主要仓库。 Capgo

capacitor-updater

您想修复一个 bug 或添加一个新功能到 capacitor-updater ? 这是您想贡献的仓库。

语言： capacitor-updaterLanguages:

This is the main repository that provides the Swift, JavaScript, Java

capgo

构成Capgo云平台的Web应用和无服务器函数。

分享您想贡献的位置来修复Capgo的后端。

语言： TypeScript.

website

官方Deno网页的前端： https://capgo.app/

语言： TypeScriptHTML、CSS

docs

简化中文文档 https://docs.capgo.app

支持语言: Markdown

capacitor-standard-version

版本管理器，用于CI/CD更新应用

支持语言: JavaScript

• 阅读 样式指南

• 在 社区聊天室

• 在工作一个问题时，提及在问题评论中 在开始处理问题之前 当您工作于新功能时，创建一个问题并与其他贡献者讨论

• 在开始处理功能之前 在开始处理功能之前，我们非常感谢您的贡献，但并非所有提出的功能都被接受。我们不希望您花费几个小时在可能不会被接受的__CAPGO_KEEP_0__上 you start working on the feature; we appreciate all contributions, but not all proposed features are getting accepted. We don't want you to spend hours working on a code that might not be accepted.

• Rust的 code (行为守则)。遇到问题？请发送邮件到 ry@tinyclouds.org

提交拉取请求

在提交任何仓库的PR之前，请确保以下内容已完成：

1. 为PR起一个描述性的标题

提交好的 PR 标题的例子：

• 修复(std/http): 修复服务器中的竞争条件
• docs(console): 更新文档字符串
• feat(doc): 处理嵌套导出

提交不好的 PR 标题的例子：

• 修复 #7123
• 更新文档

• 修复 bug

• 确保有相关的问题并且在 PR 文本中引用它。

• 确保有测试来覆盖更改。

提交到 Capgo

另外，确保：

1. bun run lint 检查 - 这将检查 Rust 和 JavaScript code 中的常见错误和错误 Swiftlint (用于 Swift) 和 eslint (用于 JavaScript 和 Java)

API 文档

重要的是要对所有公共 API 进行文档化，我们希望在 code 中进行文档化。这有助于确保 code 和文档紧密耦合在一起

JavaScript 和 TypeScript

所有公开暴露的 API 和类型， capacitor-updater 模块应该具有 JSDoc 文档。该文档被解析并可供 TypeScript 编译器使用，因此可以轻松提供进一步的下游文档。 JSDoc 块出现在它们应用的语句之前，并以一个 /** 结束。例如： */更多信息请参见：

export const FOO = "foo";
        

https://jsdoc.app/ passes - this will check Rust and JavaScript __CAPGO_KEEP_0__ for common mistakes and errors using