Skip to content

Commit eba79b5

Browse files
update contributing guide and dev deps (run-llama#17051)
1 parent 70ff5e0 commit eba79b5

File tree

4 files changed

+427
-314
lines changed

4 files changed

+427
-314
lines changed

Diff for: CONTRIBUTING.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,21 @@ If you're ready to dive in, here’s a quick setup guide to get you going:
1919
```
2020
4. Install development (and/or docs) dependencies:
2121
```bash
22-
poetry install --only dev,docs
22+
poetry install --only dev,docs --no-root
2323
```
24-
5. Install the package(s) you want to work on:
24+
5. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:
25+
2526
```bash
2627
pip install -e llama-index-core
2728
```
28-
or for specific integrations:
29+
30+
From there, you can install specific integrations that you want to work on:
31+
2932
```bash
3033
pip install -e llama-index-integrations/llms/llama-index-llms-openai
3134
```
3235

33-
**That’s it!** If anything seems unclear, scroll down to the [Development Guidelines](#development-guidelines) for more details.
36+
**That’s it!** If anything seems unclear, scroll down to the [Development Guidelines](#-Development-Guidelines) for more details.
3437

3538
---
3639

@@ -173,7 +176,18 @@ LlamaIndex is organized as a **monorepo**, meaning different packages live withi
173176
```
174177
3. Install dependencies:
175178
```bash
176-
poetry install --only dev,docs
179+
poetry install --only dev,docs --no-root
180+
```
181+
4. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:
182+
183+
```bash
184+
pip install -e llama-index-core
185+
```
186+
187+
From there, you can install specific integrations that you want to work on:
188+
189+
```bash
190+
pip install -e llama-index-integrations/llms/llama-index-llms-openai
177191
```
178192

179193
### Running Tests

Diff for: docs/docs/CONTRIBUTING.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,19 @@ If you're ready to dive in, here’s a quick setup guide to get you going:
1919
```
2020
4. Install development (and/or docs) dependencies:
2121
```bash
22-
poetry install --only dev,docs
22+
poetry install --only dev,docs --no-root
2323
```
24-
5. Install the package(s) you want to work on:
24+
5. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:
2525
```bash
2626
pip install -e llama-index-core
2727
```
28-
or for specific integrations:
28+
29+
From there, you can install specific integrations that you want to work on:
2930
```bash
3031
pip install -e llama-index-integrations/llms/llama-index-llms-openai
3132
```
3233

33-
**That’s it!** If anything seems unclear, scroll down to the [Development Guidelines](#development-guidelines) for more details.
34+
**That’s it!** If anything seems unclear, scroll down to the [Development Guidelines](#-Development-Guidelines) for more details.
3435

3536
---
3637

@@ -173,7 +174,18 @@ LlamaIndex is organized as a **monorepo**, meaning different packages live withi
173174
```
174175
3. Install dependencies:
175176
```bash
176-
poetry install --only dev,docs
177+
poetry install --only dev,docs --no-root
178+
```
179+
4. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:
180+
181+
```bash
182+
pip install -e llama-index-core
183+
```
184+
185+
From there, you can install specific integrations that you want to work on:
186+
187+
```bash
188+
pip install -e llama-index-integrations/llms/llama-index-llms-openai
177189
```
178190

179191
### Running Tests

0 commit comments

Comments
 (0)