Contributing Guide

Thank you for your interest in contributing to Agent Development Kit (ADK)! We welcome contributions to the core frameworks, documentation, and related components, which are listed below.

感谢您对 Agent Development Kit (ADK) 贡献的兴趣！我们欢迎对核心框架、文档和相关组件的贡献，这些组件在下方列出。

This guide provides information on how to get involved.

本指南提供了如何参与贡献的信息。

Preparing to contribute¶

准备贡献¶

Choose the right repository¶

选择合适的仓库¶

The ADK project is split across several repositories. Find the right one for your contribution:

ADK 项目分布在多个仓库中。为您的贡献找到合适的仓库：

Repository	Description	Detailed Guide
`google/adk-python`	Contains the core Python library source code	`CONTRIBUTING.md`
`google/adk-python-community`	Contains community-contributed tools, integrations, and scripts	`CONTRIBUTING.md`
`google/adk-js`	Contains the core JavaScript library source code	`CONTRIBUTING.md`
`google/adk-go`	Contains the core Go library source code	`CONTRIBUTING.md`
`google/adk-java`	Contains the core Java library source code	`CONTRIBUTING.md`
`google/adk-docs`	Contains the source for the documentation site you are currently reading	`CONTRIBUTING.md`
`google/adk-samples`	Contains sample agents for ADK	`CONTRIBUTING.md`
`google/adk-web`	Contains the source for the `adk web` dev UI

These repositories typically include a CONTRIBUTING.md file in the root of their repository with more detailed information on requirements, testing, code review processes, etc. for that particular component.

这些仓库通常在根目录下包含一个 CONTRIBUTING.md 文件，其中提供了关于该特定组件的要求、测试、代码审查流程等的更详细信息。

Sign a CLA¶

签署 CLA¶

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

对此项目的贡献必须附有贡献者许可协议(CLA)。您（或您的雇主）保留对您贡献的版权；这仅仅是授予我们许可，以便作为项目的一部分使用和重新分发您的贡献。

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

如果您或您当前的雇主已经签署了 Google CLA（即使是针对不同的项目），您可能不需要再次签署。

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

访问 https://cla.developers.google.com/ 查看您当前的协议或签署新的协议。

Review community guidelines¶

审阅社区准则¶

This project follows Google's Open Source Community Guidelines.

本项目遵循Google 开源社区准则。

Join the discussion¶

参与讨论¶

Have questions, want to share ideas, or discuss how you're using ADK? Head over to our Python, TypeScript, Go, or Java Discussions!

有问题、想分享想法，或讨论您如何使用 ADK？前往我们的 Python、 TypeScript、 Go 或 Java 讨论区！

This is the primary place for:

这是主要场所：

Asking questions and getting help from the community and maintainers.
Sharing your projects or use cases (Show and Tell).
Discussing potential features or improvements before creating a formal issue.
General conversation about ADK.
提出问题并从社区和维护者那里获得帮助。
分享您的项目或用例（展示和讲述）。
在创建正式 issue 之前讨论潜在的功能或改进。
关于 ADK 的一般性对话。

How to contribute¶

如何贡献¶

There are several ways you can contribute to ADK:

您可以通过多种方式为 ADK 做出贡献：

Reporting issues¶

报告问题¶

If you find a bug in the framework or an error in the documentation:

如果您在框架中发现错误或在文档中发现错误：

Framework Bugs: Open an issue in google/adk-python, google/adk-js, google/adk-go, or google/adk-java
Documentation Errors: Open an issue in google/adk-docs (use bug template)
框架错误： 在 google/adk-python、 google/adk-js、 google/adk-go 或 google/adk-java 中提交 issue
文档错误： 在 google/adk-docs 中提交 issue（使用错误模板）

Suggesting enhancements¶

建议增强功能¶

Have an idea for a new feature or an improvement to an existing one?

有新功能或改进现有功能的想法吗？

Framework Enhancements: Open an issue in google/adk-python, google/adk-js, google/adk-go, or google/adk-java
Documentation Enhancements: Open an issue in google/adk-docs
框架增强： 在 google/adk-python、 google/adk-js、 google/adk-go 或 google/adk-java 中提交 issue
文档增强： 在 google/adk-docs 中提交 issue

Improving documentation¶

改进文档¶

Found a typo, unclear explanation, or missing information? Submit your changes directly:

发现了拼写错误、不清楚的解释或缺失的信息？直接提交您的更改：

How: Submit a Pull Request (PR) with your suggested improvements.
Where: Create a Pull Request in google/adk-docs
如何： 提交包含您建议改进的 Pull Request (PR)。
在哪里： 在 google/adk-docs 中创建 Pull Request

Writing code¶

编写代码¶

Help fix bugs, implement new features or contribute code samples for the documentation:

帮助修复错误、实现新功能或为文档贡献代码示例：

How: Submit a Pull Request (PR) with your code changes.

如何： 提交包含您代码更改的 Pull Request (PR)。

Python Framework: Create a Pull Request in google/adk-python
TypeScript Framework: Create a Pull Request in google/adk-js
Go Framework: Create a Pull Request in google/adk-go
Java Framework: Create a Pull Request in google/adk-java
Documentation: Create a Pull Request in google/adk-docs
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

Code reviews¶

代码审查¶

All contributions, including those from project members, undergo a review process.
所有贡献，包括来自项目成员的贡献，都要经过审查流程。
We use GitHub Pull Requests (PRs) for code submission and review. Please ensure your PR clearly describes the changes you are making.
我们使用 GitHub Pull Requests (PR) 进行代码提交和审查。请确保您的 PR 清楚地描述了您所做的更改。

License¶

许可证¶

By contributing, you agree that your contributions will be licensed under the project's Apache 2.0 License.

通过贡献，您同意您的贡献将在项目的 Apache 2.0 License 下获得许可。

Questions?¶

有问题吗？¶

If you get stuck or have questions, feel free to open an issue on the relevant repository's issue tracker.

如果遇到困难或有疑问，请随时在相关仓库的 issue 追踪器中打开一个 issue。