Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 40 additions & 30 deletions docs/contributing-guide.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
Thank you for your interest in contributing to the Agent Development Kit (ADK)! We welcome contributions to both the core framework (Python and Java) and its documentation.
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.

This guide provides information on how to get involved.

## 1. [`google/adk-python`](https://github.com/google/adk-python) { #google-adk-python }
## Preparing to contribute

Contains the core Python library source code.
### Choose the right repository

## 2. [`google/adk-java`](https://github.com/google/adk-java) { #google-adk-java }
The ADK project is split across several repositories. Find the right one for
your contribution:

Contains the core Java library source code.
Repository | Description | Detailed Guide
--- | --- | ---
[`google/adk-python`](https://github.com/google/adk-python) | Contains the core Python library source code | [`CONTRIBUTING.md`](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md)
[`google/adk-python-community`](https://github.com/google/adk-python-community) | Contains community-contributed tools, integrations, and scripts | [`CONTRIBUTING.md`](https://github.com/google/adk-python-community/blob/main/CONTRIBUTING.md)
[`google/adk-java`](https://github.com/google/adk-java) | Contains the core Java library source code | [`CONTRIBUTING.md`](https://github.com/google/adk-java/blob/main/CONTRIBUTING.md)
[`google/adk-docs`](https://github.com/google/adk-docs) | Contains the source for the documentation site you are currently reading | [`CONTRIBUTING.md`](https://github.com/google/adk-docs/blob/main/CONTRIBUTING.md)
[`google/adk-web`](https://github.com/google/adk-web) | Contains the source for the `adk web` dev UI |

## 3. [`google/adk-docs`](https://github.com/google/adk-docs) { #google-adk-docs }
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.

Contains the source for the documentation site you are currently reading.

## 4. [`google/adk-web`](https://github.com/google/adk-web) { #google-adk-web }

Contains the source for the `adk web` dev UI.

## Before you begin

### ✏️ Sign our Contributor License Agreement
### Sign a CLA

Contributions to this project must be accompanied by a
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
Expand All @@ -34,48 +37,50 @@ was for a different project), you probably don't need to do it again.
Visit <https://cla.developers.google.com/> to see your current agreements or to
sign a new one.

### 📜 Review our community guidelines
### Review community guidelines

This project follows
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).

## 💬 Join the Discussion!
## Join the discussion

Have questions, want to share ideas, or discuss how you're using the ADK? Head over to our **[Python](https://github.com/google/adk-python/discussions)** or **[Java](https://github.com/google/adk-java/discussions)** Discussions!
Have questions, want to share ideas, or discuss how you're using ADK? Head over
to our **[Python](https://github.com/google/adk-python/discussions)** or
**[Java](https://github.com/google/adk-java/discussions)** Discussions!

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 the ADK.
* General conversation about ADK.

## How to Contribute
## How to contribute

There are several ways you can contribute to the ADK:
There are several ways you can contribute to ADK:

### 1. Reporting Issues (Bugs & Errors) { #reporting-issues-bugs-errors }
### Reporting issues { #reporting-issues-bugs-errors }

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

* **Framework Bugs:** Open an issue in [`google/adk-python`](https://github.com/google/adk-python/issues/new) or in [`google/adk-java`](https://github.com/google/adk-java/issues/new)
* **Documentation Errors:** [Open an issue in `google/adk-docs` (use bug template)](https://github.com/google/adk-docs/issues/new?template=bug_report.md)

### 2. Suggesting Enhancements { #suggesting-enhancements }
### Suggesting enhancements { #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`](https://github.com/google/adk-python/issues/new) or in [`google/adk-java`](https://github.com/google/adk-java/issues/new)
* **Documentation Enhancements:** [Open an issue in `google/adk-docs`](https://github.com/google/adk-docs/issues/new)

### 3. Improving Documentation { #improving-documentation }
### Improving documentation { #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`](https://github.com/google/adk-docs/pulls)

### 4. Writing Code { #writing-code }
### Writing code { #writing-code }

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

Expand All @@ -85,16 +90,21 @@ Help fix bugs, implement new features or contribute code samples for the documen
* **Java Framework:** [Create a Pull Request in `google/adk-java`](https://github.com/google/adk-java/pulls)
* **Documentation:** [Create a Pull Request in `google/adk-docs`](https://github.com/google/adk-docs/pulls)

### Code Reviews
### Code reviews

* All contributions, including those from project members, undergo a review process.
* 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.
* We use GitHub Pull Requests (PRs) for code submission and review. Please
ensure your PR clearly describes the changes you are making.

## License

By contributing, you agree that your contributions will be licensed under the project's [Apache 2.0 License](https://github.com/google/adk-docs/blob/main/LICENSE).
By contributing, you agree that your contributions will be licensed under the
project's
[Apache 2.0 License](https://github.com/google/adk-docs/blob/main/LICENSE).

## Questions?

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