すべてのCapgoへの貢献を歓迎し、感謝しています。
このページは、貢献を始めるのに役立つヘルパーとして機能します。
プロジェクト
__CAPGO_KEEP_0__エコシステムの一部である組織内の多数のリポジトリがあります。 Capgo organization that are part of the Capgo ecosystem.
あなたが貢献したいリポジトリを選択するのに役立つために、以下の短い比較表をご覧ください (<strong>コードベースのほとんどを占める言語は太字で表記されています</strong>):
このは主なリポジトリであり、 Capgo
capacitor-updater
__CAPGO_KEEP_0__を提供しています。 capacitor-updater プラグイン。
あなたはバグを修正したい、または新機能を追加したい capacitor-updater? このリポジトリに貢献したい。
言語: Swift, JavaScript, Java
capgo
Webアプリケーションとserverless関数で構成されるCapgoクラウドプラットフォーム。
Capgoのバックエンドを修正したい場所を共有する。
言語: TypeScript.
website
公式Denoウェブサイトのフロントエンド: https://capgo.app/
言語: TypeScript、HTML、CSS
docs
ドキュメントはMarkdown形式で https://docs.capgo.app
言語: Markdown
capacitor-standard-version
バージョン管理ツールはCI/CDを通じてアプリケーションをアップデートする
言語: JavaScript
-
READMEを読む スタイルガイド。
-
コミュニティチャットルームで助けを求めます。 問題を解決している際は、問題コメントでその旨を記載してください。
-
問題を解決する前に 問題を解決します。 新機能を実装する際は、問題を作成し、他の貢献者と議論しましょう。
-
新機能を実装する前に 新機能を実装する前に、すべての提案された機能が受け入れられるわけではないため、時間を費やすのではなく、すべての提案された機能が受け入れられるかどうかを確認してください。 you start working on the feature; we appreciate all contributions, but not all proposed features are getting accepted. We don't want you to spend hours working on a code that might not be accepted.
-
私たちは Rust's code of conduct (CoC)を遵守しています。問題が発生した場合は、メールを送信してください。 ry@tinyclouds.org.
プルリクエストを提出する
リポジトリのいずれかにプルリクエストを提出する前に、以下のことを確認してください:
- プルリクエストのタイトルを記述的に設定する
記述的なプルリクエストのタイトルの例:
- fix(std/http): サーバー内でのレース条件を修正する
- docs(console): ドキュメントのドキュメントを更新する
- feat(doc): ネストされた再エクスポートを処理する
記述的なプルリクエストのタイトルの例:
- fix #7123
- ドキュメントを更新する
-
バグを修正する
-
関連する問題が存在し、PRのテキストに参照されていることを確認する。
- 変更にカバーされるテストが存在することを確認する。
__CAPGO_KEEP_0__に__CAPGO_KEEP_0__を提出する。 Capgo
上記の他に、以下を確認すること。
bun run lintパスする - これは、RustとJavaScript codeで共通のミスやエラーを検出するために使用される。Swiftlint(Swiftの場合) およびeslint(JavaScriptおよびJavaの場合)
APIのドキュメント
APIをすべての公開APIと型をドキュメント化することが重要であり、codeにinlineでドキュメント化することが望ましい。これにより、codeとドキュメントが密接に結びつく。
JavaScriptとTypeScript
すべての公開APIと型、モジュールにはJSDocドキュメントが必要である。 このドキュメントは、TypeScriptコンパイラによってパースされ、さらに下流で提供されることが容易である。 JSDocブロックは、適用するstatementの前に来ることと、先頭に記述されることによって識別される。 capacitor-updater PRを提出するものは /** 終了前に */. 例えば:
export const FOO = "foo";
詳しくはこちら: https://jsdoc.app/