Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ourownstory authored Oct 5, 2023
1 parent 1f9f6e7 commit 75bbfba
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ Please come join us on our [Slack](https://join.slack.com/t/neuralprophet/shared
If this is your first time contributing to NeuralProphet, please read our [wiki summary](https://github.com/ourownstory/neural_prophet/wiki#contributing-process) of the steps involved.

## Dev Install using Poetry
* First, [install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer). Next, change directories to your cloned neuralprophet github. There, run `poetry shell` to (create and) start a (new) poetry virtual environment. If you run `poetry env info --path` you should see the path to the venv.
Prerequisite: [install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer).
* Start by cloning the repo with `git clone <copied link from github>`.
* Make sure you have changed directories to your cloned neuralprophet github `cd neural_prophet`. There, run `poetry shell` to (create and) start a (new) poetry virtual environment. If you run `poetry env info --path` you should see the path to the venv.
* To complete the venv setup, install neuralprophet (in editable mode by default) with `poetry install`.
Note: poetry will automatically use the specific dependencies in the `poetry.lock` file for reproducibility. If you want to install the latest dependencies instead, run `poetry update`. This will update all dependencies and update the `poetry.lock` file. Be mindful to not track the `poetry.lock` file with git when commiting, unless the purpose of your pull request is to update it.

Expand Down

0 comments on commit 75bbfba

Please sign in to comment.