CONTRIBUTING.md

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.

Setting up a development environment

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

Tests

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

Examples

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

yarn build:src
yarn minimize
yarn build:examples
cd example/dockpanel

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

There are also tests in some of the examples. These can be run as:

yarn test:examples

Static Examples

There are static examples built into the documentation. Having them in docs allows us to test examples in the ReadTheDocs build for a PR.

To add an example to the static examples:

• Add appropriate link in: docs/source/examples.rst
• Add the example name to the EXAMPLES in docs/source/conf.py
• Add ignore-links config in package.json