Move uv install under install dependencies

PiperOrigin-RevId: 757008562
This commit is contained in:
Selcuk Gun 2025-05-09 20:33:05 -07:00 committed by Copybara-Service
parent 2a0524692b
commit 4c191ba6b9

View File

@ -4,21 +4,21 @@ We'd love to accept your patches and contributions to this project.
## Table of Contents ## Table of Contents
- [Before you begin](#before-you-begin) - [Before you begin](#before-you-begin)
- [Sign our Contributor License Agreement](#sign-our-contributor-license-agreement) - [Sign our Contributor License Agreement](#sign-our-contributor-license-agreement)
- [Review our community guidelines](#review-our-community-guidelines) - [Review our community guidelines](#review-our-community-guidelines)
- [Contribution workflow](#contribution-workflow) - [Contribution workflow](#contribution-workflow)
- [Finding Issues to Work On](#finding-issues-to-work-on) - [Finding Issues to Work On](#finding-issues-to-work-on)
- [Requirement for PRs](#requirement-for-prs) - [Requirement for PRs](#requirement-for-prs)
- [Large or Complex Changes](#large-or-complex-changes) - [Large or Complex Changes](#large-or-complex-changes)
- [Testing Requirements](#testing-requirements) - [Testing Requirements](#testing-requirements)
- [Unit Tests](#unit-tests) - [Unit Tests](#unit-tests)
- [End-to-End (E2E) Tests](#manual-end-to-end-e2e-tests) - [End-to-End (E2E) Tests](#manual-end-to-end-e2e-tests)
- [Documentation](#documentation) - [Documentation](#documentation)
- [Development Setup](#development-setup) - [Development Setup](#development-setup)
- [Code reviews](#code-reviews) - [Code reviews](#code-reviews)
## Before you begin ## Before you begin
### Sign our Contributor License Agreement ### Sign our Contributor License Agreement
@ -44,13 +44,13 @@ This project follows
### Finding Issues to Work On ### Finding Issues to Work On
- Browse issues labeled **`good first issue`** (newcomer-friendly) or **`help wanted`** (general contributions). - Browse issues labeled **`good first issue`** (newcomer-friendly) or **`help wanted`** (general contributions).
- For other issues, please kindly ask before contributing to avoid duplication. - For other issues, please kindly ask before contributing to avoid duplication.
### Requirement for PRs ### Requirement for PRs
- All PRs, other than small documentation or typo fixes, should have a Issue assoicated. If not, please create one. - 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. - 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. - For bug fixes or features, please provide logs or screenshot after the fix is applied to help reviewers better understand the fix.
- Please include a `testing plan` section in your PR to talk about how you will test. This will save time for PR review. See `Testing Requirements` section for more details. - Please include a `testing plan` section in your PR to talk about how you will test. This will save time for PR review. See `Testing Requirements` section for more details.
@ -72,12 +72,12 @@ Please add or update unit tests for your change. Please include a summary of pas
Requirements for unit tests: Requirements for unit tests:
- **Coverage:** Cover new features, edge cases, error conditions, and typical use cases. - **Coverage:** Cover new features, edge cases, error conditions, and typical use cases.
- **Location:** Add or update tests under `tests/unittests/`, following existing naming conventions (e.g., `test_<module>_<feature>.py`). - **Location:** Add or update tests under `tests/unittests/`, following existing naming conventions (e.g., `test_<module>_<feature>.py`).
- **Framework:** Use `pytest`. Tests should be: - **Framework:** Use `pytest`. Tests should be:
- Fast and isolated. - Fast and isolated.
- Written clearly with descriptive names. - Written clearly with descriptive names.
- Free of external dependencies (use mocks or fixtures as needed). - Free of external dependencies (use mocks or fixtures as needed).
- **Quality:** Aim for high readability and maintainability; include docstrings or comments for complex scenarios. - **Quality:** Aim for high readability and maintainability; include docstrings or comments for complex scenarios.
#### Manual End-to-End (E2E) Tests #### Manual End-to-End (E2E) Tests
@ -86,15 +86,15 @@ Manual E2E tests ensure integrated flows work as intended. Your tests should cov
Depending on your change: Depending on your change:
- **ADK Web:** - **ADK Web:**
- Use the `adk web` to verify functionality. - Use the `adk web` to verify functionality.
- Capture and attach relevant screenshots demonstrating the UI/UX changes or outputs. - Capture and attach relevant screenshots demonstrating the UI/UX changes or outputs.
- Label screenshots clearly in your PR description. - Label screenshots clearly in your PR description.
- **Runner:** - **Runner:**
- Provide the testing setup. For example, the agent definition, and the runner setup. - Provide the testing setup. For example, the agent definition, and the runner setup.
- Execute the `runner` tool to reproduce workflows. - Execute the `runner` tool to reproduce workflows.
- Include the command used and console output showing test results. - Include the command used and console output showing test results.
- Highlight sections of the log that directly relate to your change. - Highlight sections of the log that directly relate to your change.
### Documentation ### Documentation
@ -117,19 +117,16 @@ For any changes that impact user-facing documentation (guides, API reference, tu
```shell ```shell
source .venv/bin/activate source .venv/bin/activate
``` ```
**windows** **windows**
```shell ```shell
source .\.venv\Scripts\activate source .\.venv\Scripts\activate
``` ```
```shell
pip install uv
```
3. **Install dependencies:** 3. **Install dependencies:**
```shell ```shell
pip install uv
uv sync --all-extras uv sync --all-extras
``` ```
4. **Run unit tests:** 4. **Run unit tests:**