我们欢迎并感谢所有对 Capgo 的贡献。
这一页作为贡献的帮助工具。
项目
该组织有许多仓库是 __CAPGO_KEEP_0__ 生态系统的一部分。 Capgo Capgo 生态系统的一部分组织。
各个仓库都有不同的范围,使用不同的编程语言,并且贡献度各不相同。
为了帮助您决定哪个仓库可能是最好的开始贡献(并且符合您的兴趣),以下是仓库的简要比较(<strong>**语言**在代码库中占绝大多数</strong>):
Capgo
capacitor-updater
这是主要仓库,提供 capacitor-updater 插件。
您想修复一个bug或添加一个新功能到 capacitor-updater? 这是您想贡献的仓库。
语言: Swift, JavaScript, Java
capgo
构成Capgo云平台的Web应用和无服务器函数。
分享您想贡献的位置来修复Capgo的后端。
语言: TypeScript.
website
官方Deno网页的前端: https://capgo.app/
语言: TypeScriptHTML, CSS
docs
支持Markdown的文档 https://docs.capgo.app
语言: Markdown
capacitor-standard-version
Markdown
语言: JavaScript
-
阅读 风格指南。
-
在社区聊天室中 社区聊天室。
-
当您处理一个问题时,请在问题评论中提及 在开始处理一个问题之前 您开始处理问题时。
-
当您处理一个新功能时,请创建一个问题并与其他贡献者讨论 在开始处理一个问题之前 您开始处理功能时;我们感谢所有贡献,但不是所有提出的功能都被接受。我们不希望您花费几个小时处理一个code,它可能不会被接受。
-
请在论坛中保持专业。我们遵循 Rust's code of conduct (行为准则)。遇到问题?邮件 请在论坛中保持专业。
提交拉取请求
在提交任何仓库的PR之前,请确保以下内容已完成:
- 为PR起一个描述性的标题。
好的PR标题示例:
- 修复(std/http): 修复服务器的竞争条件
- 修复(docs/console): 更新文档字符串
- feat(doc): 处理嵌套导出
坏的PR标题示例:
- 修复 #7123
- 更新文档
-
修复 bug
-
确保有相关问题并在 PR 文本中引用它。
- 确保有覆盖更改的测试。
向 Capgo
context
bun run lintnpm_run_lint_passes - 这将检查 Rust 和 JavaScript code 以及常见的错误和错误。SwiftlintCapgo 提交 PReslint另外,确保:
context
It is important to document all public APIs and we want to do that inline with the code. This helps ensure that code and documentation are tightly coupled together.
JavaScript 和 TypeScript
All 公开 API 和类型, capacitor-updater 模块应具有 JSDoc 文档。 这些文档被解析并可供 TypeScript 编译器使用,因此提供进一步信息的过程变得容易。 JSDoc 块出现在它们适用的 statement 之前,并以一个开头的符号标记, /** 终止于一个 */. 例如:
export const FOO = "foo";
更多信息请参见: https://jsdoc.app/