贡献指南
感谢你对 Agent Development Kit (ADK) 项目的贡献兴趣!我们欢迎对核心框架、文档和相关组件的贡献,如下所列。
AI 智能体开发套件(Agent Development Kit, ADK)项目及其英文文档归属 Google 所有并维护。
本站为 ADK 文档的中文版本,由 ADK.Wiki 运营,内容由 ADK.Wiki 独立维护,并保持与上游文档google/adk-docs 保持同步更新。
本贡献指南不适用于当前中文版本内容改进。
本指南提供了如何参与的信息。
贡献前的准备¶
选择正确的代码仓库¶
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¶
对本项目的贡献必须附有贡献者许可协议 (CLA)。
你(或你的雇主)保留对你贡献的版权;这只是给予我们使用和重新分发你的贡献作为项目一部分的许可。
如果你或你当前的雇主已经签署了 Google CLA(即使是为不同的项目),你可能不需要再次签署。
查看社区准则¶
参与讨论¶
有问题、想分享想法或讨论你如何使用 ADK?前往我们的 Python、TypeScript、Go 或 Java 讨论区!
如何贡献¶
有几种方式你可以为 ADK 做出贡献:
报告问题(错误和错误)¶
如果你在框架中发现错误或文档中的错误:
- 框架错误: 在
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)。
- 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 许可证 进行许可。
问题?¶
如果你遇到困难或有疑问,请随时在相关仓库的 issue 跟踪器中开启一个 issue。