我们欢迎并感谢所有对 Capgo 的贡献。
本页面作为一个帮助工具,帮助您开始贡献。
项目
该组织中有许多仓库是 __CAPGO_KEEP_0__ 生态系统的一部分。 Capgo organization that are part of the Capgo ecosystem.
为了帮助您决定哪个仓库可能是开始贡献的最佳选择(并且符合您的兴趣),以下是仓库的简要比较(<strong> **语言** 在代码库中占据了大部分):
这是主要仓库,提供了
Capgo
capacitor-updater
插件。 capacitor-updater 您想修复一个 bug 或添加一个新功能到
? 这是您想贡献的仓库。 capacitor-updater语言:
scope: contributing, pagePath: /zh/contributing/, protectedTokens: ["Cloudflare","Capacitor","GitHub","Capgo","code","API","SDK","CLI","npm","bun"] Swift, JavaScript, Java
capgo
构成Capgo云平台的Web应用和无服务器函数。
分享你想为Capgo修复后端的位置。
语言: TypeScript.
website
Capgo官方Deno网页前端: https://capgo.app/
语言: TypeScript, HTML, CSS
docs
在 Markdown 中的文档 https://docs.capgo.app
语言: Markdown
capacitor-standard-version
CI/CD 的版本管理器,负责更新应用
语言: JavaScript
-
阅读 风格指南
-
在社区聊天室中寻求帮助 社区聊天室
-
在工作一个问题时,务必在问题评论中提及 在开始工作新功能之前,创建一个问题并与其他贡献者讨论 您开始工作于该问题
-
当您工作于新功能时,请创建一个问题并与其他贡献者讨论 在开始工作新功能之前,创建一个问题并与其他贡献者讨论 您开始工作于该功能;我们感谢所有贡献,但并非所有提出的功能都被接受。我们不希望您花费几个小时工作于code可能不会被接受的功能
-
请在论坛中保持专业,我们遵循 Rust的code行为准则 (CoC).遇到问题?请发邮件 ry@tinyclouds.org.
提交一个拉取请求
在提交任何仓库的PR之前,请确保以下内容已完成:
- 为PR起一个描述性的标题
为好 PR 标题提供的例子:
- 修复(std/http): 修复服务器中的竞争条件
- 修复(docs/console): 更新文档字符串
- feat(doc): 处理嵌套导出
为坏 PR 标题提供的例子:
- 修复 #7123
- 更新文档
-
修复 bug
-
确保有相关问题并在 PR 文本中引用它。
- 确保有测试来覆盖更改。
向 Capgo 提交 PR Capgo
此外,确保:
bun run lint通过 npm 运行 lint - 这将检查 Rust 和 JavaScript code 中的常见错误和错误Swiftlint(适用于 Swift)和eslint(适用于 JavaScript 和 Java)
文档 API
文档所有公共 API 很重要,我们希望在 code 中进行文档。这有助于确保 code 和文档紧密耦合
JavaScript 和 TypeScript
所有公开暴露的 API 和类型, capacitor-updater 模块应该具有 JSDoc 文档。这份文档被解析并可供 TypeScript 编译器使用,因此提供进一步信息也很容易。JSDoc 块出现在它们应用的 statement 之前,并以一个开头的 /** 前面 */。例如:
export const FOO = "foo";
在这里找到更多信息: https://jsdoc.app/