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

We welcome and appreciate all contributions to Capgo.

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

プロジェクト

__CAPGO_KEEP_0__ エコシステムの一部である組織内の複数のリポジトリがあります。 Capgo organization that are part of the Capgo ecosystem.

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

__CAPGO_KEEP_0__ の主なリポジトリです。 Capgo

capacitor-updater

プラグインを提供します。 capacitor-updater bugを修正したい、または新機能を追加したい場合は?

このリポジトリに貢献したい場合はこちらのリポジトリをご覧ください。 capacitor-updater言語:

organization スワフト, JavaScript, Java

capgo

Capgoクラウドプラットフォームで構成されるWebアプリケーションとserverless関数。

Capgoのバックエンドを修正するために貢献したい場所を共有してください。

言語: TypeScript.

website

公式Denoウェブサイトのフロントエンド: capgo.app/

言語: TypeScript, HTML, CSS

docs

ドキュメント https://docs.capgo.app

言語: マークダウン

capacitor-standard-version

バージョン管理ツールはCI/CDを使用してアプリをアップデートする

言語: JavaScript

  • スタイルガイドを読む コミュニティチャットルームで助けを求める

  • 問題に取り組んでいる場合、そのことを問題コメントで記載する 言語:

  • Markdown 開始する前に 問題に取り組む前に

  • 新機能に取り組む場合、問題を作成し、他の貢献者と議論する 開始する前に 機能に取り組む前に; すべての提案された機能が受け入れられるわけではないため、すべての提案された機能に取り組む必要はありません。時間を費やす必要のある code が却下される可能性があるため、時間を費やす必要のある code に取り組まないようにしてください。

  • フォーラムでは、専門的で丁寧な対応を心がけてください。 Rust's code of conduct コントリビューションルール (CoC)。問題がある場合は、ry@tinyclouds.orgまでご連絡ください。

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

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

  1. プルリクエストのタイトルを説明的に入力してください。

PRの良い例のタイトル:

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

PRの悪い例のタイトル:

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

  • 関連する問題が存在し、PRのテキストで参照されていることを確認する

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

CapgoにPRを提出する Capgo

上記の要件に加えて、以下を確認する

  1. bun run lint Rust と JavaScript code をチェックして、一般的なミスやエラーを検出します。 Swiftlint (Swift 用) と eslint (JavaScript と Java 用)

API のドキュメント

すべてのパブリック API をドキュメント化し、code とドキュメントをinline で統合したいと思います。これにより、code とドキュメントが密接に結びつきます。

JavaScript と TypeScript

すべてのパブリック API とタイプ、モジュールには JSDoc ドキュメントが必要です。このドキュメントは TypeScript コンパイラーでパースされ、さらに下流で簡単に提供できるため、便利です。JSDoc ブロックは、適用するステートメントの前に来て、__CAPGO_KEEP_0__ で始まり、__CAPGO_KEEP_1__ で終わります。 capacitor-updater 例えば: /** 詳しくはこちらを参照してください: */https://jsdoc.app/

export const FOO = "foo";
        

passes - this will check Rust and JavaScript __CAPGO_KEEP_0__ for common mistakes and errors using (for Swift) and