Contributing to Lumino

Lumino is a subproject of Project Jupyter and subject to the Jupyter governance and Code of conduct.

General Guidelines

For general documentation about contributing to Jupyter projects, see the Project Jupyter Contributor Documentation.

Lumino requires nodejs and yarn for local development. After cloning Lumino, run the following to install dependencies and build the source:

yarn
yarn build:src

The tests are written using karma to simulate a browser environment.

To run the tests, run:

yarn build:test
yarn test  # optionally test:chrome, test:firefox, or test:ie

Lumino examples are in the examples/ folder. To build and run an example:

yarn build:examples
cd example/dockpanel

Open the index.html file in a browser to see the running example.