Skip to content

Update CONTRIBUTING.md to include jupyter lab local development instr… #5274

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update CONTRIBUTING.md to include jupyter lab local development instr… #5274

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27b8e6d
Update CONTRIBUTING.md to include jupyter lab local development instr…
marthacryan Jul 10, 2025
a2a3d65
Update CONTRIBUTING.md
marthacryan Jul 18, 2025
c2a34e8
Update CONTRIBUTING.md
marthacryan Jul 18, 2025
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain when to run this command -- does it need to be run only when setting up the environment, or after every change? Also briefly what does it do / what happens if you don't run it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just tried to update it! How does it look?

```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
Expand Down