Skip to main content

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

这个页面作为一个助手,帮助你开始贡献。

项目

Capgo组织中有许多仓库是Capgo的一部分。

存储库有不同的范围,使用不同的编程语言,并在贡献方面有不同的级别。

为了帮助您决定开始贡献的仓库可能是哪个最好(和/或符合您的兴趣),这里有一个简短的比较(<strong>粗体字表示占代码库大部分的语言</strong>): Capgo

capacitor-updater

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

您想要修复一个错误或者为capacitor-updater添加新功能吗?这就是您想要贡献的仓库。

Languages: Swift, JavaScript, Java

capgo

构成Capgo云平台的Webapp和无服务器函数。

你想要为修复Capgo的后端做出贡献。

Languages: TypeScript.

website

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

Languages: TypeScript, HTML, CSS

docs

驱动的Markdown文档 https://docs.capgo.app

Languages: Markdown

capacitor-standard-version

驱动CI/CD更新应用的版本管理器。

Languages: JavaScript

  • 阅读 样式指南。

  • 社区聊天室寻求帮助。

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

  • 当你开始开发新功能时,创建一个问题并在开始工作之与其他贡献者讨论;我们欣赏所有的贡献,但并非所有提出的特性都会被接受。我们不希望你花费数小时来编写可能无法被接受的代码。

  • 请在论坛中保持专业。我们遵循 Rust的行为准则(CoC)。有问题吗?发送邮件至 ry@tinyclouds.org。

提交拉取请求

在提交PR到任何仓库之前,请确保已完成以下操作:

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

优秀公关标题的示例:

  • fix(std/http): Fix race condition in server
  • docs(console): Update docstrings
  • feat(doc): Handle nested re-exports

错误的公关标题示例:

  • fix #7123
  • update docs
  • fix bugs

  • Ensure there is a related issue and it is referenced in the PR text.

  • Ensure there are tests that cover the changes.

Capgo提交PR

除了上述内容外,请确保:

  1. npm run lint通过 - 这将使用Swiftlint(用于Swift)和eslint(用于JavaScript和Java)检查Rust和JavaScript代码中的常见错误和错误

记录APIs

记录所有公共API非常重要,我们希望与代码一起进行这项工作。这有助于确保代码和文档紧密地结合在一起。

JavaScript 和 TypeScript

所有公开暴露的API和类型,capacitor-updater模块应该有JSDoc文档。这个文档被解析并可供TypeScript编译器使用,因此很容易提供进一步的下游服务。JSDoc块紧接在它们所适用的语句之前,并以一个前导的/**开始,在一个*/结束。例如:

export const FOO = "foo";
        

在此处查找更多信息: https://jsdoc.app/