跳过主要内容

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

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

项目

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

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

这是提供 Capgo

capacitor-updater

插件 capacitor-updater 的主要仓库。

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

语言: Swift, JavaScript, Java

capgo

Capgo 云平台的 Webapp 和无服务器函数组成部分。

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

语言: TypeScript.

website

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

语言: TypeScript、HTML、CSS

docs

使用 Markdown 的文档 https://docs.capgo.app

语言: Markdown

capacitor-standard-version

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

语言: JavaScript

  • 阅读 风格指南。

  • 社区聊天室

  • 中寻求帮助。 当您处理一个问题时,在问题评论中提及它 之前

  • 当您工作于新功能时,创建一个问题并与其他贡献者讨论 您开始工作于该功能之前;我们感谢所有贡献,但不是所有提出的功能都被接受。我们不希望您花费几个小时工作于一个code,可能不会被接受。

  • 请在论坛中保持专业。我们遵循 Rust's code of conduct __CAPGO_KEEP_0__ (CoC)。遇到问题?请发邮件到

ry@tinyclouds.org。

提交一个拉取请求

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

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

  • 好的PR标题的例子:
  • docs(console): 更新文档字符串
  • feat(doc): 处理嵌套重导出

不良 PR 标题的例子:

  • 修复 #7123
  • 更新文档
  • 修复错误

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

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

提交到 Capgo

此外,确保:

  1. bun run lint 通过 - 这将检查 Rust 和 JavaScript code 以及使用的常见错误和错误 Swiftlint (适用于 Swift) eslint (for JavaScript and Java)

API 文档

为了确保 API 和文档紧密结合,所有公共 API 都应在 code 中进行文档化。这样可以确保 code 和文档紧密结合。

JavaScript 和 TypeScript

所有公开暴露的 API 和类型,模块应具有 JSDoc 文档。该文档将被解析并可供 TypeScript 编译器使用,因此可以轻松提供进一步的文档。 JSDoc 块位于它们应用的 statement 之前,并以一个 capacitor-updater 结束。例如: /** Find more at: */https://jsdoc.app/

export const FOO = "foo";
        

底部 使用 __CAPGO_KEEP_0__ 构建您的应用