Skip to content

docs: recommend entering the pixi shell #5967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

docs: recommend entering the pixi shell #5967

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ or [on Discord](https://marimo.io/discord?ref=contributing).

## Setup

Install [pixi](https://github.com/prefix-dev/pixi) to manage your development environment. The following command uses `pixi` to launch a development shell with all dependencies installed, using `hatch` as the environment manager.
Install [pixi](https://github.com/prefix-dev/pixi) to manage your development environment. The following command uses `pixi` to launch a development shell with all the necessary tooling installed.

> [!NOTE]
>
Expand All @@ -30,7 +30,13 @@ Install [pixi](https://github.com/prefix-dev/pixi) to manage your development en
> Note that developing in Gitpod is not officially supported by the marimo team.

```bash
pixi run hatch shell
pixi shell
```

You may also activate the `hatch` environment for certain `hatch`-specific commands.

```bash
hatch shell
```

Now you can install the environment frontend and Python dependencies.
Expand Down