贡献指南
感谢您对Agent Development Kit (ADK)开发工具包的兴趣!我们欢迎您为核心Python框架及其文档做出贡献。
本指南将提供参与贡献的相关信息。
1. google/adk-python
包含核心Python库源代码。
2. google/adk-docs
包含您当前阅读的文档站点源代码。
准备工作
✏️ 签署贡献者许可协议
向本项目提交贡献时需附带贡献者许可协议(CLA)。您(或您的雇主)将保留对贡献内容的版权;该协议仅授予我们将您的贡献作为项目组成部分使用和重新分发的权利。
若您或当前雇主已签署过Google CLA(即使是为其他项目签署),通常无需重复签署。
请访问https://cla.developers.google.com/查看现有协议或签署新协议。
📜 阅读社区准则
本项目遵循Google开源社区准则。
💬 加入讨论!
如有疑问、希望分享想法或讨论ADK使用经验?欢迎前往我们的GitHub讨论区!
这里是进行以下活动的主要场所:
- 向社区和维护者提问并获得帮助
- 分享您的项目或使用案例(
Show and Tell
) - 在正式提交问题前讨论潜在功能或改进方案
- 关于ADK的常规交流
贡献方式
您可以通过多种方式为ADK做出贡献:
1. 问题报告(缺陷与错误)
发现框架缺陷或文档错误时:
2. 功能建议
对新功能或现有功能改进有想法?
- 框架改进:在
google/adk-python
提交问题 - 文档改进:在
google/adk-docs
提交问题
3. 完善文档
发现拼写错误、表述不清或信息缺失?可直接提交修改:
- 方式:通过Pull Request(PR)提交改进建议
- 位置:在
google/adk-docs
创建PR
4. 代码编写
协助修复缺陷、实现新功能或为文档贡献代码示例:
- 方式:通过Pull Request(PR)提交代码变更
- 框架:在
google/adk-python
创建PR - 文档:在
google/adk-docs
创建PR
代码审查
-
所有贡献(包括项目成员的贡献)均需经过审查流程。
-
我们使用GitHub Pull Requests(PRs)进行代码提交与审查。请确保您的PR清晰描述所做变更。
许可协议
参与贡献即表示您同意贡献内容将遵循项目的Apache 2.0许可协议。
仍有疑问?
若遇到困难或有疑问,可在对应代码库的问题跟踪器中提交问题。