Skip to content

Commit

Permalink
update contributing guide and dev deps (#17051)
Browse files Browse the repository at this point in the history
  • Loading branch information
logan-markewich authored Nov 25, 2024
1 parent 70ff5e0 commit eba79b5
Show file tree
Hide file tree
Showing 4 changed files with 427 additions and 314 deletions.
24 changes: 19 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,21 @@ If you're ready to dive in, here’s a quick setup guide to get you going:
```
4. Install development (and/or docs) dependencies:
```bash
poetry install --only dev,docs
poetry install --only dev,docs --no-root
```
5. Install the package(s) you want to work on:
5. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:

```bash
pip install -e llama-index-core
```
or for specific integrations:

From there, you can install specific integrations that you want to work on:

```bash
pip install -e llama-index-integrations/llms/llama-index-llms-openai
```

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

---

Expand Down Expand Up @@ -173,7 +176,18 @@ LlamaIndex is organized as a **monorepo**, meaning different packages live withi
```
3. Install dependencies:
```bash
poetry install --only dev,docs
poetry install --only dev,docs --no-root
```
4. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:

```bash
pip install -e llama-index-core
```

From there, you can install specific integrations that you want to work on:

```bash
pip install -e llama-index-integrations/llms/llama-index-llms-openai
```

### Running Tests
Expand Down
22 changes: 17 additions & 5 deletions docs/docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,19 @@ If you're ready to dive in, here’s a quick setup guide to get you going:
```
4. Install development (and/or docs) dependencies:
```bash
poetry install --only dev,docs
poetry install --only dev,docs --no-root
```
5. Install the package(s) you want to work on:
5. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:
```bash
pip install -e llama-index-core
```
or for specific integrations:

From there, you can install specific integrations that you want to work on:
```bash
pip install -e llama-index-integrations/llms/llama-index-llms-openai
```

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

---

Expand Down Expand Up @@ -173,7 +174,18 @@ LlamaIndex is organized as a **monorepo**, meaning different packages live withi
```
3. Install dependencies:
```bash
poetry install --only dev,docs
poetry install --only dev,docs --no-root
```
4. Install the package(s) you want to work on. You will for sure need to install `llama-index-core`:

```bash
pip install -e llama-index-core
```

From there, you can install specific integrations that you want to work on:

```bash
pip install -e llama-index-integrations/llms/llama-index-llms-openai
```

### Running Tests
Expand Down
Loading

0 comments on commit eba79b5

Please sign in to comment.