CONTRIBUTING#

Help Wanted#

tackling roadmap issues
improving testing
improving (self-hosted) documentation
improving the binder demo
improving continuous integration and developer experience

Prerequisites#

doit >=0.32
jupyterlab >=3,<4
nodejs >=18,<19
python >=3.8

Recommended: `mamba`#

Get Miniforge/Mambaforge

mamba env update --file .github/environment.yml
source activate ipydrawio

or use the demo environment in .binder

Get to a working Lab#

doit

Start JupyterLab#

doit serve:lab

Start JupyterLite#

doit serve:demo

Prepare a Release#

doit dist

Do everything#

doit all

Updating drawio#

update the version in packages/ipydrawio-webpack/package.json
update dependencies in other package.json

pushd packages/ipydrawio-webpack/drawio
git fetch
git checkout v<the new version>
popd
doit dist

validate everything looks good!

Releasing#

Start a release issue on GitHub
- Follow the checklist