贡献指南¶
感谢你对 Agent Development Kit (ADK) 项目的关注与贡献热情!我们热忱欢迎社区成员针对核心框架、官方文档及相关生态组件提交各类改进建议,具体范围如下所述。
加入社区¶
- 想要讨论 ADK、提问,或谈论有关智能体的一切?请前往 Reddit 上的 r/agentdevelopmentkit。
- 想要获取每月社区会议的更新?请加入 ADK 社区 Google Group。
- 想要提交错误或为 ADK 框架做贡献?请参阅下文以了解如何找到正确的仓库并开始贡献。
准备参与贡献¶
[!IMPORTANT] 关于版权与维护说明 * AI 智能体开发套件(Agent Development Kit, ADK)主项目及其原始英文文档完全归 Google 所有并负责维护。 * 本站点为 ADK 文档的镜像中文版本,由 ADK.Wiki 独立运营并维系中文内容的本地化工作。 * 我们致力于与上游官方仓库
google/adk-docs保持实时同步更新。 * 注意:本指南旨在指导你如何向全球开源主项目进行贡献,而非针对当前中文站点的改进。
贡献前的准备工作¶
选择正确的代码仓库¶
ADK 生态由多个职能明确的仓库组成,请根据你的贡献目标选择对应的仓库:
| 仓库名称 | 职能描述 | 详细贡献指南 |
|---|---|---|
google/adk-python |
核心 Python 框架库源代码。 | CONTRIBUTING.md |
google/adk-python-community |
社区贡献的工具集、集成插件及实用脚本。 | CONTRIBUTING.md |
google/adk-js |
核心 JavaScript/TypeScript 库源代码。 | CONTRIBUTING.md |
google/adk-go |
核心 Go 语言库源代码。 | CONTRIBUTING.md |
google/adk-java |
核心 Java 语言库源代码。 | CONTRIBUTING.md |
google/adk-docs |
官方文档站点的 Markdown 源代码。 | CONTRIBUTING.md |
google/adk-samples |
各种场景下的官方示例智能体实现。 | CONTRIBUTING.md |
google/adk-web |
adk web 开发 UI 界面的源代码。 |
— |
[!TIP] 上述各仓库根目录下通常都有针对该特定组件的
CONTRIBUTING.md,涉及更为详细的测试要求、环境配置及代码规范。
签署贡献者许可协议 (CLA)¶
提交至本项目的受控贡献必须附带已签署的贡献者许可协议 (CLA)。
- 版权归属:你(或你的雇主)依然保留对贡献内容的版权;签署 CLA 仅表示你授权我们作为项目的一部分对你的贡献进行分发和使用。
- 无需重复签署:如果你或你的雇主之前已经为 Google 的其它开源项目签署过 CLA,通常无需再次签署。
如何参与贡献¶
报告问题或文档错误¶
如果你在框架中发现了 Bug,或者在文档中发现了表述偏差:
- 框架缺陷:请前往对应的语言仓库(如
google/adk-python)开启一个新的 Issue。 - 文档错误:请在
google/adk-docs中使用 Bug 报送模板提交 Issue。
提交功能增强建议¶
对于新功能的绝妙点子或对现有流程的优化建议:
- 框架增项:在对应的核心语言仓库(
python/js/go/java)开启 Issue。 - 文档增项:在
google/adk-docs中直接提交 Issue。
编写并提交代码¶
操作流程:通过 GitHub 提交包含你代码变更的 Pull Request (PR)。
- Python 框架:前往
google/adk-python提交 PR - TypeScript 框架:前往
google/adk-js提交 PR - Go 框架:前往
google/adk-go提交 PR - Java 框架:前往
google/adk-java提交 PR - 官方文档:前往
google/adk-docs提交 PR
代码审查流程说明¶
- 全员审查:包括项目核心成员在内的所有贡献,都必须经过标准的代码审查流程。
- 描述清晰:请确保你的 PR 描述清晰详细,准确交代了“为什么改”以及“改了什么”。
开源许可证声明¶
一旦提交贡献,即表示你同意你的作品将遵循项目的 Apache 2.0 许可证 进行授权。
常见问题咨询¶
如果你在贡献过程中遇到技术瓶颈或对流程有疑惑,请随时在相关仓库的 Issue Tracker 中留言探讨。
感谢你对 ADK 开源社区的每一份热忱参与!❤️