Skip to content

Commit 29a37af

Browse files
committed
docs: clarify Poetry workflow and add optional shell plugin instructions
1 parent d69d533 commit 29a37af

1 file changed

Lines changed: 22 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,30 @@ You'll need:
4545
poetry install
4646
```
4747

48-
Use `poetry run <command>` to run commands inside the environment. Alternatively, activate the environment with:
48+
**Recommended**: Use `poetry run` to run commands inside the virtual environment:
4949

5050
```bash
51-
poetry env activate
51+
poetry run pytest
52+
poetry run python script.py
53+
```
54+
55+
**Optional**: If you prefer an interactive shell session, install the shell plugin first:
56+
57+
```bash
58+
poetry self add poetry-plugin-shell
59+
```
60+
61+
Then activate the environment with:
62+
63+
```bash
64+
poetry shell
65+
```
66+
67+
After activation, commands run directly inside the virtual environment:
68+
69+
```bash
70+
pytest
71+
python script.py
5272
```
5373

5474
5. **Install pre-commit hooks**

0 commit comments

Comments
 (0)