Capgo logo

私たちはCapgoへのすべての貢献を歓迎し、感謝します。

このページは、貢献を始めるための手助けとなるものです。

プロジェクト

Capgo組織には、Capgoの一部である多数のリポジトリがあります。

リポジトリには異なる範囲があり、異なるプログラミング言語を使用し、貢献のレベルもさまざまです。

どのリポジトリが貢献を始めるのに最適か（またはあなたの興味に合うか）を決定するのを助けるために、以下は簡単な比較です（太字の言語はコードベースの大部分を占めています）：

capacitor-updater

これは、capacitor-updater プラグインを提供する主要なリポジトリです。

capacitor-updaterにバグを修正したり新機能を追加したりしたいですか？これは貢献したいリポジトリです。

Languages: Swift, JavaScript, Java

capgo

Capgoクラウドプラットフォームを構成するWebアプリとサーバーレス機能。

Capgoのバックエンドを修正するために貢献したいところです。

Languages: TypeScript.

website

公式Denoウェブページのフロントエンド: https://capgo.app/

Languages: TypeScript, HTML, CSS

docs

文書はMarkdownで記述されており、その背後にあります https://doc.capgo.app

Languages: Markdown

capacitor-standard-version

アプリを更新するためのCI/CDを強化するバージョン管理ツール。

Languages: JavaScript

  • スタイルガイドをお読みください。

  • <ā href="https://discord.com/invite/VnYRvBfgA6">コミュニティチャットルームで助けを求めてください。

  • 問題に取り組む際は、その旨を問題のコメントに作業を始める前に記載してください。

  • 新しい機能に取り組む際は、作業を始める前に、イシューを作成し、他の貢献者と話し合ってください。私たちはすべての貢献を感謝していますが、提案されたすべての機能が受け入れられるわけではありません。受け入れられないかもしれないコードに何時間も費やしてほしくありません。

  • フォーラムではプロフェッショナルでいてください。私たちはRustの行動規範 (CoC)に従っています。問題がありますか？ry@tinyclouds.orgまでメールしてください。

プルリクエストの提出

PRをリポジトリに提出する前に、次のことを確認してください:

  1. PRに説明的なタイトルを付けてください。

良いPRタイトルの例:

  • fix(std/http): Fix race condition in server
  • docs(console): Update docstrings
  • feat(doc): Handle nested re-exports

悪いPRタイトルの例：

  • fix #7123
  • update docs

  • fix bugs

  • Ensure there is a related issue and it is referenced in the PR text.

  • Ensure there are tests that cover the changes.

Capgo への PR を提出しています。

上記に加えて、以下の点を確認してください：

  1. `npm run lint` が成功しました - これは、RustおよびJavaScriptコードの一般的な間違いやエラーをチェックします。使用するのは `Swiftlint`（Swift用）および `eslint`（JavaScriptおよびJava用）です。

APIの文書化

すべての公開APIを文書化することは重要であり、私たちはそれをコード内に組み込みたいと考えています。これにより、コードと文書が密接に結びついていることが保証されます。

JavaScript と TypeScript

すべての公開されているAPIおよび型について、capacitor-updaterモジュールにはJSDocドキュメントが必要です。このドキュメントは解析され、TypeScriptコンパイラで利用可能であり、したがってさらに下流に提供するのが容易です。JSDocブロックは、それが適用されるステートメントの直前に置かれ、/**で始まり、*/で終了することで示されます。例えば：

export const FOO = "foo";

詳細はここを参照してください: https://jsdoc.app/