Skip to content

Commit 25b7de6

Browse files
authored
doc: Improve the developer.md file to segregate install and test steps. (#99)
1 parent 2c06c7d commit 25b7de6

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

DEVELOPER.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
1-
## Development
1+
# Development
22

3-
Below are the details to set up a development environment:
3+
Below are the details to set up a development environment and run tests.
44

5+
## Install
56
1. Clone the repository:
67
```bash
78
git clone https://github.com/googleapis/genai-toolbox.git
89
```
10+
1. Navigate to the SDK directory:
11+
```bash
12+
cd genai-toolbox/sdks/langchain
13+
```
14+
1. Install the package in editable mode, so changes are reflected without reinstall:
15+
```bash
16+
pip install -e .
17+
```
18+
1. Make code changes and contribute to the SDK's development.
19+
> [!TIP]
20+
> Using `-e` option allows you to make changes to the SDK code and have
21+
> those changes reflected immediately without reinstalling the package.
22+
23+
## Test
924
1. Navigate to the SDK directory:
1025
```bash
1126
cd genai-toolbox/sdks/langchain
@@ -15,6 +30,7 @@ Below are the details to set up a development environment:
1530
pip install -e .[test]
1631
```
1732
1. Run tests and/or contribute to the SDK's development.
33+
1834
```bash
1935
pytest
2036
```

0 commit comments

Comments
 (0)