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
-
以下の スタイルガイド。
-
コミュニティのチャットルームで ヘルプを求めましょう。
-
Issueに取り組む際は、Issueのコメント欄で の前に 作業を開始したことを明記してください。
-
新機能に取り組む際は、Issueを作成し、他のコントリビューターと議論してください。 の前に 機能の開発を開始する前に、すべての貢献に感謝していますが、提案された機能がすべて採用されるわけではありません。採用されない可能性があるcodeに何時間も費やしたくないためです。
-
フォーラムではプロフェッショナルな態度でお願いします。私たちは Rustのcode (CoC)に従っています。問題がある場合は、 ry@tinyclouds.orgまでメールをお送りください。
プルリクエストの提出
リポジトリにPRを提出する前に、以下の項目が完了していることを確認してください：
- PRには説明のつかせるタイトルを付けます。
良いPRタイトルの例：
- fix(std/http): サーバーの競合状態を修正
- docs(console): docstringを更新
- feat(doc): ネストされた再エクスポートの処理
不適切なPRタイトルの例:
- fix #7123
- ドキュメントを更新
-
バグを修正
-
関連する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/