From 27b8e6d5d0bfc3b2bcb5b13c3a23c1c3392703bf Mon Sep 17 00:00:00 2001 From: Martha Cryan Date: Wed, 9 Jul 2025 19:47:53 -0500 Subject: [PATCH 1/3] Update CONTRIBUTING.md to include jupyter lab local development instructions --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad666ea805..1201389ad8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,6 +120,12 @@ you can install all packages with: pip install -e '.[dev]' ``` +If you're testing local changes in Jupyter Lab or Jupyter Notebook, you'll want to run: +```bash +pip install jupyter +jupyter labextension develop . +``` + These commands also create an *editable install* of plotly.py so that you can test your changes iteratively without having to rebuild the plotly.py package explicitly; for more information please see From a2a3d65360abc23cf3d9d8ebd6be8cbc6a77ad0f Mon Sep 17 00:00:00 2001 From: Martha Cryan Date: Fri, 18 Jul 2025 14:24:47 -0500 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1201389ad8..ccc23e9980 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,12 +120,19 @@ you can install all packages with: pip install -e '.[dev]' ``` -If you're testing local changes in Jupyter Lab or Jupyter Notebook, you'll want to run: +If you're testing local changes in Jupyter Lab or Jupyter Notebook, you'll want to run these commands when you're setting up your development environment: ```bash pip install jupyter jupyter labextension develop . ``` +If you're changing any of the code under the `js/` directory, you'll also want to run these commands: +``` +cd js/ +npm ci +npm run build +``` + These commands also create an *editable install* of plotly.py so that you can test your changes iteratively without having to rebuild the plotly.py package explicitly; for more information please see From c2a34e87911251a7ffec1623c14bdd42fe286bc8 Mon Sep 17 00:00:00 2001 From: Martha Cryan Date: Fri, 18 Jul 2025 14:27:30 -0500 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ccc23e9980..7617a34bf6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -125,6 +125,7 @@ If you're testing local changes in Jupyter Lab or Jupyter Notebook, you'll want pip install jupyter jupyter labextension develop . ``` +If you don't run that command, your figure will not render in the Jupyter Lab/ Jupyter Notebook editors. If you're changing any of the code under the `js/` directory, you'll also want to run these commands: ```