コントリビューションガイド
Agent Development Kit (ADK)への貢献にご興味をお持ちいただき、ありがとうございます!私たちは、コアフレームワーク(PythonおよびJava)とそのドキュメントの両方への貢献を歓迎します。
このガイドでは、参加方法について説明します。
1. google/adk-python
¶
Pythonコアライブラリのソースコードが含まれています。
2. google/adk-java
¶
Javaコアライブラリのソースコードが含まれています。
3. google/adk-docs
¶
現在ご覧になっているドキュメントサイトのソースが含まれています。
4. google/adk-web
¶
adk web
開発UIのソースが含まれています。
始める前に¶
✏️ コントリビューターライセンス契約に署名する¶
このプロジェクトへの貢献には、コントリビューターライセンス契約 (CLA) への同意が必要です。あなた(またはあなたの雇用主)が貢献部分の著作権を保持しますが、これにより、プロジェクトの一部としてあなたの貢献を使用および再配布する許可が私たちに与えられます。
もしあなたまたは現在の雇用主がすでにGoogle CLAに署名している場合(それが別のプロジェクトのためであっても)、再度署名する必要はないでしょう。
https://cla.developers.google.com/ にアクセスして、現在の契約状況を確認したり、新しい契約に署名したりできます。
📜 コミュニティガイドラインを確認する¶
このプロジェクトはGoogleのオープンソースコミュニティガイドラインに従います。
💬 ディスカッションに参加しましょう!¶
質問がありますか?アイデアを共有したいですか?ADKをどのように使っているか話したいですか?私たちの Python または Java のディスカッションにぜひご参加ください!
ここは主に次のような場所です:
- 質問をしたり、コミュニティやメンテナーから助けを得る。
- あなたのプロジェクトやユースケースを共有する(
Show and Tell
)。 - 正式なIssueを作成する前に、潜在的な機能や改善について議論する。
- ADKに関する一般的な会話。
貢献の方法¶
ADKに貢献するには、いくつかの方法があります:
1. Issueの報告(バグとエラー)¶
フレームワークのバグやドキュメントのエラーを見つけた場合:
- フレームワークのバグ:
google/adk-python
またはgoogle/adk-java
にIssueをオープンしてください。 - ドキュメントのエラー:
google/adk-docs
でIssueをオープンしてください(バグテンプレートを使用)
2. 改善の提案¶
新機能のアイデアや既存機能の改善案がある場合:
- フレームワークの機能強化:
google/adk-python
またはgoogle/adk-java
にIssueをオープンしてください。 - ドキュメントの改善:
google/adk-docs
でIssueをオープンしてください
3. ドキュメントの改善¶
タイプミス、不明確な説明、不足している情報を見つけましたか?変更を直接送信してください:
- 方法: 提案する改善点を含むプルリクエスト(PR)を送信してください。
- 場所:
google/adk-docs
でプルリクエストを作成
4. コードの作成¶
バグの修正、新機能の実装、ドキュメント用のコードサンプルの提供などを手伝ってください:
方法: コードの変更を含むプルリクエスト(PR)を送信してください。
- Pythonフレームワーク:
google/adk-python
でプルリクエストを作成 - Javaフレームワーク:
google/adk-java
でプルリクエストを作成 - ドキュメント:
google/adk-docs
でプルリクエストを作成
コードレビュー¶
-
プロジェクトメンバーからのものを含め、すべての貢献はレビュープロセスを経ます。
-
私たちはコードの提出とレビューにGitHubのプルリクエスト(PR)を使用します。PRには、行っている変更内容を明確に記述してください。
ライセンス¶
貢献することにより、あなたの貢献がプロジェクトのApache 2.0 Licenseの下でライセンスされることに同意したことになります。
質問がありますか?¶
行き詰まったり質問がある場合は、関連するリポジトリのIssueトラッカーで気軽にIssueをオープンしてください。