跳过主要内容

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

帮助您开始贡献。

项目

Capgo 仓库中有许多仓库 Capgo Capgo 生态系统的一部分组织。

各个仓库有不同的范围,使用不同的编程语言,贡献度也有所不同。

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

capacitor-updater

这是提供 capacitor-updater 插件的主要仓库。

您想修复一个错误或添加一个新功能? 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.

  • 请在论坛中保持专业的态度。我们遵循 Rust's code of conduct (CoC)。遇到问题?请发邮件到 ry@tinyclouds.org。

提交拉取请求

在提交任何仓库的PR之前,请确保以下步骤完成:

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

好的PR标题示例:

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

坏的PR标题示例:

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

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

  • 确保有测试覆盖更改。

提交到 Capgo

此外,以上的内容,请确保:

  1. npm run lint 通过 - 这将检查Rust和JavaScript code,使用 Swiftlint (对于Swift) 和 eslint (对于JavaScript和Java)

文档API

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

JavaScript 和 TypeScript

所有公开暴露的 API 和类型,模块应该具有 JSDoc 文档。这份文档被解析并可供 TypeScript 编译器使用,因此可以轻松提供进一步的下游文档。JSDoc 块在它们应用的 statement 之前出现,并以一个 capacitor-updater 开始, /** 结束。 */例如:

export const FOO = "foo";
        

更多信息请参见: https://jsdoc.app/