コントリビューションガイド
Agent Development Kit(ADK)へのご貢献に関心をお寄せいただき、ありがとうございます。以下に挙げるコアフレームワーク、ドキュメント、および関連コンポーネントへの貢献を歓迎します。
このガイドでは、参加方法をご案内します。
貢献の準備¶
適切なリポジトリを選ぶ¶
ADK プロジェクトはいくつかのリポジトリに分かれています。あなたの貢献に適したものを見つけてください。
| リポジトリ | 説明 | 詳細ガイド |
|---|---|---|
google/adk-python |
コア Python ライブラリのソースコードが含まれています。 | CONTRIBUTING.md |
google/adk-python-community |
コミュニティ提供のツール、インテグレーション、スクリプトが含まれています。 | CONTRIBUTING.md |
google/adk-js |
コア JavaScript ライブラリのソースコードが含まれています。 | CONTRIBUTING.md |
google/adk-go |
コア Go ライブラリのソースコードが含まれています。 | CONTRIBUTING.md |
google/adk-java |
コア Java ライブラリのソースコードが含まれています。 | CONTRIBUTING.md |
google/adk-docs |
現在ご覧になっているドキュメントサイトのソースが含まれています。 | CONTRIBUTING.md |
google/adk-samples |
ADK のサンプルエージェントが含まれています。 | CONTRIBUTING.md |
google/adk-web |
adk web 開発 UI のソースが含まれています。 |
これらのリポジトリには通常、ルートに CONTRIBUTING.md ファイルがあり、要件、テスト、コードレビューの流れなど、各コンポーネントの詳細情報が記載されています。
CLA に署名する¶
このプロジェクトへの貢献には、Contributor License Agreement(CLA)への同意が必要です。あなた(またはあなたの雇用主)は貢献物の著作権を保持し、この契約によって、プロジェクトの一部としてあなたの貢献を使用および再配布する許可が私たちに与えられます。
あなたまたは現在の雇用主がすでに Google CLA に署名している場合(別のプロジェクト向けであっても)、再度署名する必要はないかもしれません。
https://cla.developers.google.com/ で現在の契約状況を確認するか、新しい契約に署名してください。
コミュニティガイドラインを確認する¶
このプロジェクトは Google のオープンソースコミュニティガイドライン に従います。
ディスカッションに参加する¶
質問がありますか。アイデアを共有したいですか。あるいは ADK の使い方について話したいですか。Python、TypeScript、Go、Java の Discussions へどうぞ。
ここは主に次のための場です。
- 質問をしたり、コミュニティやメンテナーから助けを得る
- プロジェクトやユースケースを共有する(
Show and Tell) - 正式な Issue を作成する前に、機能改善や変更案を議論する
- ADK に関する一般的な会話
貢献方法¶
ADK にはいくつかの方法で貢献できます。
Issue を報告する¶
フレームワークのバグやドキュメントの誤りを見つけた場合は:
- フレームワークのバグ:
google/adk-python、google/adk-js、google/adk-go、またはgoogle/adk-javaに Issue を作成してください。 - ドキュメントの誤り: バグテンプレートを使って
google/adk-docsに Issue を作成
改善提案をする¶
新機能や既存機能の改善アイデアがありますか。
- フレームワークの改善:
google/adk-python、google/adk-js、google/adk-go、またはgoogle/adk-javaに Issue を作成してください。 - ドキュメントの改善:
google/adk-docsに Issue を作成してください。
ドキュメントを改善する¶
タイポ、不明瞭な説明、情報の不足を見つけましたか。変更を直接提出してください。
- 方法: 提案する改善を含む Pull Request(PR)を送信してください。
- 場所:
google/adk-docsで Pull Request を作成
コードを書く¶
バグ修正、新機能の実装、またはドキュメント用のコードサンプル提供にご協力ください。
方法: コード変更を含む Pull Request(PR)を送信してください。
- Python フレームワーク:
google/adk-pythonで Pull Request を作成 - TypeScript フレームワーク:
google/adk-jsで Pull Request を作成 - Go フレームワーク:
google/adk-goで Pull Request を作成 - Java フレームワーク:
google/adk-javaで Pull Request を作成 - ドキュメント:
google/adk-docsで Pull Request を作成
コードレビュー¶
-
プロジェクトメンバーを含むすべての貢献はレビューを受けます。
-
コードの提出とレビューには GitHub Pull Request(PR)を使用します。PR には変更内容を明確に記述してください。
ライセンス¶
貢献することで、あなたの貢献がプロジェクトの Apache 2.0 License の下でライセンスされることに同意したものとみなされます。
ご質問はありますか?¶
行き詰まったり質問がある場合は、関連リポジトリの Issue トラッカーに遠慮なく Issue を作成してください。