Skip to content

Commit efc8b5a

Browse files
authored
Add instruction to install shell plugin to doc (#1674)
More context [here](#1673) Wanted to keep it as short as possible @kevinjqliu
1 parent d26d1e4 commit efc8b5a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

mkdocs/docs/contributing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ To get started, you can run `make install`, which installs Poetry and all the de
5252

5353
If you want to install the library on the host, you can simply run `pip3 install -e .`. If you wish to use a virtual environment, you can run `poetry shell`. Poetry will open up a virtual environment with all the dependencies set.
5454

55+
> **Note:** If you want to use `poetry shell`, you need to install it using `pip install poetry-plugin-shell`. Alternatively, you can run commands directly with `poetry run`.
56+
5557
To set up IDEA with Poetry:
5658

5759
- Open up the Python project in IntelliJ

0 commit comments

Comments
 (0)