Skip to content

Commit 4c191ba

Browse files
selcukguncopybara-github
authored andcommitted
Move uv install under install dependencies
PiperOrigin-RevId: 757008562
1 parent 2a05246 commit 4c191ba

File tree

1 file changed

+27
-30
lines changed

1 file changed

+27
-30
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ We'd love to accept your patches and contributions to this project.
44

55
## Table of Contents
66

7-
- [Before you begin](#before-you-begin)
8-
- [Sign our Contributor License Agreement](#sign-our-contributor-license-agreement)
7+
- [Before you begin](#before-you-begin)
8+
- [Sign our Contributor License Agreement](#sign-our-contributor-license-agreement)
99
- [Review our community guidelines](#review-our-community-guidelines)
10-
- [Contribution workflow](#contribution-workflow)
11-
- [Finding Issues to Work On](#finding-issues-to-work-on)
12-
- [Requirement for PRs](#requirement-for-prs)
13-
- [Large or Complex Changes](#large-or-complex-changes)
14-
- [Testing Requirements](#testing-requirements)
15-
- [Unit Tests](#unit-tests)
16-
- [End-to-End (E2E) Tests](#manual-end-to-end-e2e-tests)
17-
- [Documentation](#documentation)
18-
- [Development Setup](#development-setup)
10+
- [Contribution workflow](#contribution-workflow)
11+
- [Finding Issues to Work On](#finding-issues-to-work-on)
12+
- [Requirement for PRs](#requirement-for-prs)
13+
- [Large or Complex Changes](#large-or-complex-changes)
14+
- [Testing Requirements](#testing-requirements)
15+
- [Unit Tests](#unit-tests)
16+
- [End-to-End (E2E) Tests](#manual-end-to-end-e2e-tests)
17+
- [Documentation](#documentation)
18+
- [Development Setup](#development-setup)
1919
- [Code reviews](#code-reviews)
2020

21-
21+
2222
## Before you begin
2323

2424
### Sign our Contributor License Agreement
@@ -44,13 +44,13 @@ This project follows
4444

4545
### Finding Issues to Work On
4646

47-
- Browse issues labeled **`good first issue`** (newcomer-friendly) or **`help wanted`** (general contributions).
47+
- Browse issues labeled **`good first issue`** (newcomer-friendly) or **`help wanted`** (general contributions).
4848
- For other issues, please kindly ask before contributing to avoid duplication.
4949

5050

5151
### Requirement for PRs
5252

53-
- All PRs, other than small documentation or typo fixes, should have a Issue assoicated. If not, please create one.
53+
- All PRs, other than small documentation or typo fixes, should have a Issue assoicated. If not, please create one.
5454
- Small, focused PRs. Keep changes minimal—one concern per PR.
5555
- For bug fixes or features, please provide logs or screenshot after the fix is applied to help reviewers better understand the fix.
5656
- 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
7272

7373
Requirements for unit tests:
7474

75-
- **Coverage:** Cover new features, edge cases, error conditions, and typical use cases.
76-
- **Location:** Add or update tests under `tests/unittests/`, following existing naming conventions (e.g., `test_<module>_<feature>.py`).
77-
- **Framework:** Use `pytest`. Tests should be:
78-
- Fast and isolated.
79-
- Written clearly with descriptive names.
80-
- Free of external dependencies (use mocks or fixtures as needed).
75+
- **Coverage:** Cover new features, edge cases, error conditions, and typical use cases.
76+
- **Location:** Add or update tests under `tests/unittests/`, following existing naming conventions (e.g., `test_<module>_<feature>.py`).
77+
- **Framework:** Use `pytest`. Tests should be:
78+
- Fast and isolated.
79+
- Written clearly with descriptive names.
80+
- Free of external dependencies (use mocks or fixtures as needed).
8181
- **Quality:** Aim for high readability and maintainability; include docstrings or comments for complex scenarios.
8282

8383
#### Manual End-to-End (E2E) Tests
@@ -86,15 +86,15 @@ Manual E2E tests ensure integrated flows work as intended. Your tests should cov
8686

8787
Depending on your change:
8888

89-
- **ADK Web:**
90-
- Use the `adk web` to verify functionality.
91-
- Capture and attach relevant screenshots demonstrating the UI/UX changes or outputs.
89+
- **ADK Web:**
90+
- Use the `adk web` to verify functionality.
91+
- Capture and attach relevant screenshots demonstrating the UI/UX changes or outputs.
9292
- Label screenshots clearly in your PR description.
9393

9494
- **Runner:**
9595
- Provide the testing setup. For example, the agent definition, and the runner setup.
96-
- Execute the `runner` tool to reproduce workflows.
97-
- Include the command used and console output showing test results.
96+
- Execute the `runner` tool to reproduce workflows.
97+
- Include the command used and console output showing test results.
9898
- Highlight sections of the log that directly relate to your change.
9999

100100
### Documentation
@@ -117,19 +117,16 @@ For any changes that impact user-facing documentation (guides, API reference, tu
117117
```shell
118118
source .venv/bin/activate
119119
```
120-
120+
121121
**windows**
122122
```shell
123123
source .\.venv\Scripts\activate
124124
```
125125

126-
```shell
127-
pip install uv
128-
```
129-
130126
3. **Install dependencies:**
131127

132128
```shell
129+
pip install uv
133130
uv sync --all-extras
134131
```
135132
4. **Run unit tests:**

0 commit comments

Comments
 (0)