我们欢迎并感谢对 Capgo 的所有贡献。
本页面旨在帮助您快速开始参与贡献。
项目
这里有许多仓库,位于 Capgo 属于 Capgo 生态系统的组织。
不同的 Repository 范围不同,使用的编程语言也不同,且对贡献者的要求程度各异。
为了帮助你决定从哪个 Repository 开始贡献(或寻找感兴趣的方向),这里有一个简短的对比(<strong>加粗的语言构成了大部分 codebase </strong>): Capgo
capacitor-updater
这是提供核心 capacitor-updater Plugin.
如果你想修复 bug 或为 capacitor-updater添加新功能?那么这就是你想贡献的 Repository。
编程语言: Swift, JavaScript, Java
capgo
构成 Capgo 云平台的 Webapp 和 serverless functions。
告诉我们你想参与修复 Capgo 后端的哪些部分。
编程语言: TypeScript.
website
官方 Deno 网页前端: https://capgo.app/
编程语言: TypeScript,HTML、CSS
docs
为以下站点提供内容的 Markdown 文档: https://docs.capgo.app
编程语言: Markdown
capacitor-standard-version
驱动 CI/CD 实现应用更新的版本管理器。
编程语言: JavaScript
-
阅读 代码规范。
-
当你准备处理某个 issue 时,请在 issue 评论中说明 在……之前 你即将开始处理该 issue。
-
当你准备开发新功能时,请先创建一个 issue 并与其他贡献者进行讨论。 在……之前 你开始开发该功能;我们感谢所有贡献,但并非所有提议的功能都会被采纳。我们不希望你花几个小时开发一个可能不会被接受的 code。
-
请在论坛中保持专业。我们遵循 Rust 的 code(行为准则) (CoC)。遇到问题?请发送邮件至 ry@tinyclouds.org。
提交 Pull Request
在向任何仓库提交 PR 之前,请确保完成以下事项:
- 给 PR 起一个描述性的标题。
好的 PR 标题示例:
- fix(std/http): 修复服务器中的竞态条件
- docs(console): 更新 docstrings
- feat(doc): 处理嵌套的 re-exports
不合格的 PR 标题示例:
- 修复 #7123
- 更新文档
-
修复 Bug
-
确保关联了相关的 issue,并在 PR 正文中进行了引用。
- 确保测试用例已覆盖相关变更。
向 Capgo 提交 PR Capgo
除上述要求外,还请确保:
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/