跳过主要内容
Capgo logo

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

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

项目

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

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

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

capacitor-updater

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

语言： capacitor-updaterorganization

ecosystem Swift, JavaScript, Java

capgo

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

分享你想贡献的地方来修复Capgo的后端。

语言: TypeScript.

website

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

语言: TypeScript, HTML, CSS

docs

Documentation in Markdown that powers https://docs.capgo.app

语言： Markdown

capacitor-standard-version

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

语言： JavaScript

  • 阅读 style guide.

  • 在 社区聊天室中求助。

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

  • 在开始处理功能之前；我们感谢所有的贡献，但不是所有的提议功能都被接受。我们不想您花费几个小时在__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.

  • __CAPGO_KEEP_0__ Rust's code of conduct ry@tinyclouds.org。 提交一个拉取请求

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

为PR起一个描述性的标题。

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

提交的 PR 的标题示例：

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

提交的 PR 的标题示例（不推荐）：

  • 修复 #7123
  • 更新文档

  • 修复 bug

  • 确保有相关的 issue，并在 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/ Documenting APIs