Skip to content

fix: added build and local testing command #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from
Closed
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
30 changes: 28 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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 <YOUR_WHL_FILE_PATH>

[eg]: uv pip install <ADK_PROJECT_PATH>/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
Expand Down