From 41564de689376e9c35c2f2d9917e240bfbf6b7ea Mon Sep 17 00:00:00 2001 From: Kavin Kumar B <61575461+kavinkumar807@users.noreply.github.com> Date: Wed, 7 May 2025 20:42:23 -0700 Subject: [PATCH] Copybara import of the project: -- 5eabc6c1fe339e87637b9ed6d0516a3edcbcb060 by kavinkumarbaskar : fix readme pip install -- bb21018aea7a4b8d8a60e6ef42b084dae51d7845 by kavinkumarbaskar : fix: added build and local testing command -- aa1f2305b098b79480eab9ab37b744d0273a5fcf by kavinkumarbaskar : fix: added example -- 69b649d81e6757d6305c481e3415ec8f017a75ac by kavinkumarbaskar : fix: updated the windows command -- bd5202308bf08b9b44099c4cd016af23f2e2350e by kavinkumarbaskar : fix: removed redundant code COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/529 from kavinkumar807:fix-readme-pip-install a49d82d49a0cecb4cee399620c62ae10c1f3370a PiperOrigin-RevId: 756122021 --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ab4a5d..baf5c16 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -112,7 +112,18 @@ For any changes that impact user-facing documentation (guides, API reference, tu ```shell python -m venv .venv + ``` + + ```shell source .venv/bin/activate + ``` + + **windows** + ```shell + source .\.venv\Scripts\activate + ``` + + ```shell pip install uv ``` @@ -131,8 +142,23 @@ For any changes that impact user-facing documentation (guides, API reference, tu ```shell uv run pyink --config pyproject.toml ./src ``` - -## Code reviews + +6. **Build the package** + ```shell + uv build + ``` + +7. **Local Testing** + Have a simple testing folder setup as mentioned in the [quickstart](https://google.github.io/adk-docs/get-started/quickstart/) + then install the local package with changes after building it using the below command to test the changes. + + ```shell + uv pip install + + [eg]: uv pip install /dist/google_adk-0.4.0-py3-none-any.whl + ``` + +### Code reviews All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult