贡献指南
感谢您对贡献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 Discussions!
这是主要适用于以下场景的地方:
- 向社区和维护者提问并获得帮助。
- 分享您的项目或用例 (
Show and Tell)。 - 在创建正式问题之前讨论潜在的功能或改进。
- 关于Agent Development Kit的一般性对话。
如何贡献
您可以通过以下几种方式为ADK做出贡献:
1. 报告问题(错误与故障)
如果您在框架中发现错误或文档中存在错误:
- 框架错误: 在
google/adk-python中提交问题 - 文档错误: 在
google/adk-docs中提交问题(使用错误模板)
2. 建议改进
是否有一个新功能的想法或对现有功能的改进建议?
- 框架增强: 在
google/adk-python中提交问题 - 文档增强: 在
google/adk-docs中提交问题
3. 改进文档
发现拼写错误、解释不清楚或信息缺失?直接提交您的修改:
- 如何操作:提交一个包含您建议改进的Pull Request(PR)。
- 位置: 在
google/adk-docs中创建拉取请求
4. 编写代码
帮助修复错误、实现新功能或为文档贡献代码示例:
- 方式:提交一个包含代码变更的拉取请求(PR)。
- 框架: 在
google/adk-python中创建拉取请求 - 文档: 在
google/adk-docs中创建Pull Request
代码审查
-
所有贡献,包括项目成员的贡献,都需要经过审核流程。
-
我们使用GitHub Pull Requests (PRs)进行代码提交和审查。请确保您的PR清楚地描述了您所做的更改。
许可证
通过贡献,您同意您的贡献将根据项目的Apache 2.0许可证进行授权。
有问题吗?
如果您遇到问题或有疑问,请随时在相关仓库的问题跟踪器上提交问题。