Skip to content

Commit 5d92945

Browse files
authored
Merge pull request #1124 from writer/mmikita95-patch-1
docs: update CONTRIBUTING.md
2 parents 31a2674 + bad643a commit 5d92945

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,13 @@ Pull requests should be done on the `dev` branch. When the release is finalised,
2525

2626
Whether you're interested in contributing to the repository, creating a fork, or just improving your understanding of Writer Framework, these are the suggested steps for setting up a development environment.
2727

28+
- Writer Framework uses [Poetry](https://python-poetry.org/) for dependency management. Please see the [Poetry installation docs](https://python-poetry.org/docs/#installation) if you don't already have it installed.
2829
- You can install the package in editable mode using `poetry install --with build`
29-
- Enable the virtual environment with `poetry shell`
30+
- Enable the virtual environment:
31+
- Bash/Zsh/Csh: `eval "$(poetry env activate)"`
32+
- Fish: `eval (poetry env activate)`
33+
- PowerShell: `Invoke-Expression (poetry env activate)`
34+
35+
(see [Poetry docs](https://python-poetry.org/docs/managing-environments/) for more info)
3036
- Install all the dev dependencies with `alfred install.dev`
3137
- Run Writer Framework on port 5000. For example, `writer edit apps/hello --port 5000`.

0 commit comments

Comments
 (0)