Skip to content

Commit e9703ae

Browse files
authored
Added more instructions for contributors
1 parent cbe5e75 commit e9703ae

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,10 @@ We will review PRs when possible and work with you to integrate your contributio
3131

3232
Once you've forked the code and created a new branch for your work, you can run the fork in CLI mode by following these steps:
3333

34-
1. CD into the project folder `/open-interpreter`
35-
2. Install dependencies `poetry install`
36-
3. Run the program `poetry run interpreter`
37-
38-
After modifying the source code, you will need to do `poetry run interpreter` again.
34+
1. CD into the project folder by running `cd open-interpreter`.
35+
2. Install `poetry` [according to their documentation](https://python-poetry.org/docs/#installing-with-pipx), which will create a virtual environment for development + handle dependencies.
36+
3. Install dependencies by running `poetry install`.
37+
4. Run the program with `poetry run interpreter`. Run tests with `poetry run pytest -s -x`.
3938

4039
**Note**: This project uses [`black`](https://black.readthedocs.io/en/stable/index.html) and [`isort`](https://pypi.org/project/isort/) via a [`pre-commit`](https://pre-commit.com/) hook to ensure consistent code style. If you need to bypass it for some reason, you can `git commit` with the `--no-verify` flag.
4140

0 commit comments

Comments
 (0)