Skip to content

Commit 0f67843

Browse files
authored
Add adk-python-community and other updates to Contributing Guide (#775)
1 parent f07a60d commit 0f67843

File tree

1 file changed

+40
-30
lines changed

1 file changed

+40
-30
lines changed

docs/contributing-guide.md

Lines changed: 40 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
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.
1+
Thank you for your interest in contributing to Agent Development Kit (ADK)! We
2+
welcome contributions to the core frameworks, documentation, and related
3+
components, which are listed below.
24

35
This guide provides information on how to get involved.
46

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

7-
Contains the core Python library source code.
9+
### Choose the right repository
810

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

11-
Contains the core Java library source code.
14+
Repository | Description | Detailed Guide
15+
--- | --- | ---
16+
[`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)
17+
[`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)
18+
[`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)
19+
[`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)
20+
[`google/adk-web`](https://github.com/google/adk-web) | Contains the source for the `adk web` dev UI |
1221

13-
## 3. [`google/adk-docs`](https://github.com/google/adk-docs) { #google-adk-docs }
22+
These repositories typically include a `CONTRIBUTING.md` file in the root of
23+
their repository with more detailed information on requirements, testing, code
24+
review processes, etc. for that particular component.
1425

15-
Contains the source for the documentation site you are currently reading.
16-
17-
## 4. [`google/adk-web`](https://github.com/google/adk-web) { #google-adk-web }
18-
19-
Contains the source for the `adk web` dev UI.
20-
21-
## Before you begin
22-
23-
### ✏️ Sign our Contributor License Agreement
26+
### Sign a CLA
2427

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

37-
### 📜 Review our community guidelines
40+
### Review community guidelines
3841

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

42-
## 💬 Join the Discussion!
45+
## Join the discussion
4346

44-
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!
47+
Have questions, want to share ideas, or discuss how you're using ADK? Head over
48+
to our **[Python](https://github.com/google/adk-python/discussions)** or
49+
**[Java](https://github.com/google/adk-java/discussions)** Discussions!
4550

4651
This is the primary place for:
4752

4853
* Asking questions and getting help from the community and maintainers.
4954
* Sharing your projects or use cases (`Show and Tell`).
5055
* Discussing potential features or improvements before creating a formal issue.
51-
* General conversation about the ADK.
56+
* General conversation about ADK.
5257

53-
## How to Contribute
58+
## How to contribute
5459

55-
There are several ways you can contribute to the ADK:
60+
There are several ways you can contribute to ADK:
5661

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

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

6166
* **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)
6267
* **Documentation Errors:** [Open an issue in `google/adk-docs` (use bug template)](https://github.com/google/adk-docs/issues/new?template=bug_report.md)
6368

64-
### 2. Suggesting Enhancements { #suggesting-enhancements }
69+
### Suggesting enhancements { #suggesting-enhancements }
6570

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

6873
* **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)
6974
* **Documentation Enhancements:** [Open an issue in `google/adk-docs`](https://github.com/google/adk-docs/issues/new)
7075

71-
### 3. Improving Documentation { #improving-documentation }
76+
### Improving documentation { #improving-documentation }
7277

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

7580
* **How:** Submit a Pull Request (PR) with your suggested improvements.
7681
* **Where:** [Create a Pull Request in `google/adk-docs`](https://github.com/google/adk-docs/pulls)
7782

78-
### 4. Writing Code { #writing-code }
83+
### Writing code { #writing-code }
7984

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

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

88-
### Code Reviews
93+
### Code reviews
8994

90-
* All contributions, including those from project members, undergo a review process.
95+
* All contributions, including those from project members, undergo a review
96+
process.
9197

92-
* We use GitHub Pull Requests (PRs) for code submission and review. Please ensure your PR clearly describes the changes you are making.
98+
* We use GitHub Pull Requests (PRs) for code submission and review. Please
99+
ensure your PR clearly describes the changes you are making.
93100

94101
## License
95102

96-
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).
103+
By contributing, you agree that your contributions will be licensed under the
104+
project's
105+
[Apache 2.0 License](https://github.com/google/adk-docs/blob/main/LICENSE).
97106

98107
## Questions?
99108

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

0 commit comments

Comments
 (0)