From f1d1d18eec6a715203f6af82038acb92f7dd2f0a Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Tue, 18 Feb 2025 17:00:06 -0500 Subject: [PATCH] DOC: update contributing instructions --- docs/docs/contributing.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md index 8559a2fd..69608ed4 100644 --- a/docs/docs/contributing.md +++ b/docs/docs/contributing.md @@ -16,6 +16,11 @@ Icechunk is an open source (Apache 2.0) project and welcomes contributions in th ## Development ### Python Development Workflow +The Python code is developed in the `icechunk-python` subdirectory. To make changes first enter that directory: + +```bash +cd icechunk-python +``` Create / activate a virtual environment: @@ -43,6 +48,9 @@ Build the project in dev mode: ```bash maturin develop + +# or with the optional dependencies +maturin develop --extras=test,benchmark ``` or build the project in editable mode: