mirror of https://github.com/EvolutionAPI/adk-python.git synced 2025-07-13 15:14:50 -06:00

Nilesh eff5903175 Copybara import of the project:

--
6c3b8b5fa2eb9805c6f723f560e5526649dd61f0 by knileshh <neutron_stays@protonmail.com>:

fix: Correct various typos in CHANGELOG.md and test_rest_api_tool.py

Corrected the following spelling errors:
 - CHANGELOG.md: "impprovements" -> "improvements"
 - test_rest_api_tool.py: "def sample_endpiont:" -> "def sample_endpoint:"
 - CHANGELOG.md: "credentails" -> "credentials"
 - CHANGELOG.md: "auido" -> "audio"

COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/498 from knileshh:main caadbdbd78e3dc757b494f3f4d45991e88eac30d
PiperOrigin-RevId: 754189420

2025-05-02 17:36:16 -07:00

2.4 KiB

Raw Blame History

How to contribute

We'd love to accept your patches and contributions to this project.

Before you begin

Sign our Contributor License Agreement

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.

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.

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

Review our community guidelines

This project follows Google's Open Source Community Guidelines.

Contribution process

Clone the repository:

git clone git@github.com:google/adk-python.git
cd adk-python

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate
pip install uv

Install dependencies:

uv pip install -e .[dev,test,extensions,eval]

Run unit tests:
```
uv run pytest ./tests/unittests
```

Run pyink to format codebase:

uv run pyink  --config pyproject.toml ./src

Requirement for PRs

All PRs, other than small documentation or typo fixes, should have a Issue assoicated. If not, please create one.
Small, focused PRs. Keep changes minimal—one concern per PR.
For bug fixes or features, please provide logs or screenshot after the fix is applied to help reviewers better understand the fix.
Please add corresponding testing for your code change if it's not covered by existing tests.

Large or Complex Changes

For substantial features or architectural revisions:

Open an Issue First: Outline your proposal, including design considerations and impact.
Gather Feedback: Discuss with maintainers and the community to ensure alignment and avoid duplicate work

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

2.4 KiB Raw Blame History