跳过主要内容

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

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

项目

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

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

这是提供__CAPGO_KEEP_0__的主要仓库 Capgo

capacitor-updater

This is the main repository that provides the capacitor-updater 插件。

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

语言: Swift, JavaScript, Java

capgo

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

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

语言: TypeScript.

website

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

语言: TypeScript, HTML, CSS

docs

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

语言: Markdown

capacitor-standard-version

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

语言: JavaScript

  • 阅读 风格指南。

  • 社区聊天室

  • 当你处理一个问题时,在问题评论中提及 之前 你开始处理这个问题。

  • 当你处理一个新功能时,创建一个问题并与其他贡献者讨论 之前 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 Rust的行为准则(CoC)。遇到问题?发送电子邮件 ry@tinyclouds.org.

提交一个拉取请求

在提交任何仓库的拉取请求之前,请确保以下内容已经完成:

  1. 为拉取请求起一个描述性的标题

好的拉取请求标题示例:

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

坏的拉取请求标题示例:

  • 修复 #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/