メインコンテンツにスキップ

Capgoへのすべての貢献を歓迎し、感謝しています。

このページは、貢献を始めるのに役立つヘルパーとして機能します。

プロジェクト

組織には、__CAPGO_KEEP_0__エコシステムの一部となっている多数のリポジトリがあります。 Capgo organization that are part of the Capgo ecosystem.

貢献を始めるのに役立つリポジトリを決定するのに役立つために、以下の短い比較をご覧ください。(**言語はコードベースのほとんどを占めています。**)

主なリポジトリはCapacitorアップデートプラグインを提供します。 Capgo

capacitor-updater

プラグイン capacitor-updater Plugin.

Capacitorアップデーターにバグを修正したい、または新機能を追加したい capacitor-updaterCapacitorアップデーターにバグを修正したい、または新機能を追加したい。このリポジトリに貢献したい

言語: Swift, JavaScript, Java

capgo

The Webapp and serverless functions that make up the Capgo cloud platform.

Share where you want to contribute to fix the backend of Capgo.

言語: TypeScript.

website

https://capacitor.app/ https://capgo.app/

言語: TypeScriptHTML, CSS

docs

マークダウンで記述されたドキュメントが動かしている https://docs.capgo.app

言語: マークダウン

capacitor-standard-version

CI/CDを利用したアプリの更新を管理するバージョンマネージャー

言語: JavaScript

  • スタイルガイドを読みます。 スタイルガイド

  • コミュニティチャットルームで助けを求めます。 コミュニティチャットルームで助けを求めます。

  • 問題に取り組むときは、そのことをコメントに記載してください。 before 問題に対処する前に、まずは問題を理解しましょう。

  • 新機能を開発する際は、まず問題を報告し、他のコントリビューターと議論しましょう。 before 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.

  • フォーラムでは専門的かつ丁寧な対応を心がけてください。 Capgoは以下の要件を遵守しています。 Rust's code of conduct コミュニティ規約があります。問題があれば、メール ry@tinyclouds.org.

プルリクエストを提出する

Capgo のリポジトリにプルリクエストを提出する前に、以下のことを確認してください。

  1. プルリクエストに適切なタイトルを付けます。

適切なプルリクエストのタイトルの例

  • fix(std/http): サーバーでレース条件を修正する
  • docs(console): ドキュメントのドキュメントを更新する
  • feat(doc): ネストされた再エクスポートを処理する

適切なプルリクエストのタイトルの例

  • #7123 を修正
  • ドキュメントを更新する

  • バグを修正する

  • 関連のある問題が存在し、プルリクエストのテキストに参照されていることを確認してください。

  • 変更をカバーするテストが存在することを確認する。

CapgoにPRを提出する Capgo

上記に加えて、以下のことを確認する。

  1. bun run lint パスする - これは、RustとJavaScript codeで一般的なミスやエラーを検出するために使用される Swiftlint (Swift用) および eslint (JavaScriptおよびJava用)

APIのドキュメント

APIのすべての公開APIと型をドキュメント化することは重要であり、codeとドキュメントが密接に結びついていることを保証するため、codeを提供するのに役立ちます。

JavaScriptとTypeScript

すべての公開APIと型には、 capacitor-updater モジュールにはJSDocドキュメントが必要です。このドキュメントはTypeScriptコンパイラによってパースされ、さらに下流で提供することが容易になります。JSDocブロックは、適用するstatementの前に来て、 /** 終了するために */例えば:

export const FOO = "foo";

詳しくはこちら: https://jsdoc.app/