Skip to content

Latest commit

 

History

History
400 lines (280 loc) · 10.6 KB

CONTRIBUTING.md

File metadata and controls

400 lines (280 loc) · 10.6 KB
Raw

Contributing

Thanks for contributing to JupyterLite!

We follow Project Jupyter's Code of Conduct for a friendly and welcoming collaborative environment.

Setup

Get the Code

git clone https://github.com/jupyterlite/jupyterlite

if you don't have git yet, you might be able to use the instructions below to get it

Prerequisites

You'll need:

  • git
  • nodejs >=16,<17
  • yarn <2
  • python >=3.10,<3.11

Various package managers on different operating systems provide these.

A recommended approach for any platform is to install Mambaforge and use the Binder environment description checked into the repo.

mamba env update --file .binder/environment.yml
mamba activate jupyterlite-dev

To get full archive reproducibility test output, only available on Linux, also run:

mamba install -c conda-forge diffoscope

For speed in GitHub Actions, python and nodejs are installed directly. Provided you already have these, to install the full development stack:

python -m pip install -r requirements-docs.txt -r requirements-lint.txt

Development Tasks

doit

doit handles the full software lifecycle, spanning JavaScript to documentation building and link checking. It understands the dependencies between different nested tasks, usually as files that change on disk.

List Tasks

To see all of the tasks available, use the list action:

doit list --all --status

To get information about a specific task, use the info info action with the task name from the first column of list:

doit info build:js:app:retro

Task and Action Defaults

The default doit action is run which... runs the named tasks.

The default tasks are lint, build and docs:app:build, so the following are equivalent:

doit
doit lint build docs:app:build
doit run lint build docs:app:build
For reference the default `doit` tasks are defined in the `DOIT_CONFIG` variable in the [dodo.py][dodo] file.

doit serve

A number of development servers can be started for interactive local development and documentation authoring.

These offer different assets and tools, and obey different environment variables:

  • 5000: core assets from ./app:
    • doit serve:core:js
    • doit serve:core:py
  • 8000: example site ./build/docs-app on :
    • doit serve:docs:app
      • LITE_ARGS (a JSON list of strings) controls CLI arguments to jupyter lite
  • 8888: JupyterLab
    • doit serve:lab
      • LAB_ARGS (a JSON list of strings) controls CLI arguments to jupyter lab

Core JavaScript development

The JupyterLite core JS development workflow builds:

  • a ready-to-serve, empty website with:
    • a lab/index.html and supporting assets
    • a retro/*/index.html and supporting assets (for tree, editor, etc.)
    • common configuration tools
  • typedoc documentation

  • TBD: a set of component tarballs distributed on npmjs.com. See #7.

from:

  • a set of packages in the @jupyterlite namespace, , written in TypeScript
  • some buildutils
  • some webpack configuration
  • some un-compiled, vanilla JS for very early-loading utilities

    • TODO: fix this, perhaps with jsdoc tags

While most of the scripts below will be run (in the correct order based on changes) by doit, the following scripts (defined in package.json) are worth highlighting.

Quick start

Most of the development tasks can be run with one command:

yarn bootstrap

Install JavaScript Dependencies

yarn

Build Apps

To build development assets:

yarn build

To build production assets:

yarn build:prod

Serve Apps

These are not real server solutions, but they will serve all of the assets types (including .wasm) correctly for JupyterLite development, testing, and demo purposes.

To serve with scripts/serve.js, based on Node.js's http module:

yarn serve

To serve with Python's built-in http.server module (requires Python 3.7+):

yarn serve:py

Watch Sources

yarn watch

Lint/Format Sources

yarn lint

Run Unit Tests

yarn build:test
yarn test

UI Tests

jupyterlite uses the Galata framework for end to end and visual regression testing. Galata is build on top of Playwright provides a high level API to programmatically interact with the JupyterLab UI, and tools for taking screenshots and generating test reports.

Running the UI Tests locally

First install the dependencies:

cd ui-tests
yarn install

The UI tests use a custom JupyterLite website:

# in ui-tests directory

# build
yarn build

Then run the test script:

# in the ui-tests directory
yarn test

You can pass additional arguments to playwright by appending parameters to the command. For example to run the test in headed mode, yarn test --headed.

Checkout the Playwright Command Line Reference for more information about the available command line options.

Adding new UI tests

New test suites can be added to the ui-tests/tests directory. You can see some additional example test suites in the JupyterLab repo. If the tests in new suites are doing visual regression tests or HTML source regression tests then you also need to add their reference images to the -snapshots directories.

Reference Image Captures

When adding a new visual regression test, first make sure your tests pass locally on your development environment, with a reference snapshots generated in your dev environment. You can generate new reference snapshots by running the following command:

yarn test:update

To update the snapshots:

  • push the new changes to the branch
  • wait for the CI check to complete
  • go to the artifacts section and download the jupyterlite-chromium-updated-snapshots and jupyterlite-firefox-updated-snapshots archives
  • extract the archives
  • copy the -snapshots directories to replace the existing ones
  • commit and push the changes

The generated snapshots can be found on the Summary page of the CI check:

reference-snapshots

Lab Extension development

TBD: describe how the @jupyterlite/labextension works with e.g. real serverextensions

(Browser) Python Development

TBD: describe successor to pyolite, patches, etc. See #151.

(Server) Python Development

After all the yarn-related work has finished, the terminal-compatible python uses the npm-compatible tarball of app to build new sites combined with original user content.

On testing

Extra PYTEST_ARGS can be passed as a (gross) JSON string:

PYTEST_ARGS='["-s", "-x", "--ff"]' doit test:py:jupyterlite

Several tasks invoke the jupyter lite CLI, which is further described in the main docs site.

Documentation

The documentation site, served on jupyterlite.rtfd.io, uses information from different parts of the software lifecycle (e.g. contains an archive of the built app directory), so using the doit tools are recommended.

Additionally, some of the documentation is written in executable .ipynb which are converted by myst: use of doit serve:lab is encouraged for editing these.

Build Documentation

doit docs

Extra sphinx-build arguments are set by the SPHINX_ARGS environment variable. For example to fail on all warnings (the configuration for the ReadTheDocs build):

SPHINX_ARGS='["-W"]' doit docs

Watch Documentation

doit watch:docs

This also respects the SPHINX_ARGS variable. If working on the theme layer, SPHINX_ARGS='["-a", "-j8"]' is recommended, as by default static assets are not included in the calculation of what needs to be updated.

Community Tasks

Issues

JupyterLite features and bug fixes start as issues on GitHub.

  • Look through the existing issues (and pull requests!) to see if a related issue already exists or is being worked on
  • If it is new:
    • Start a new issue
    • Pick an appropriate template
    • Fill out the template
    • Wait for the community to respond

Pull Requests

JupyterLite features and fixes become real as pull requests.

Pull requests are a great place to discuss work-in-progress, but it is highly recommended to create an issue before starting work so the community can weigh in on choices.

  • Fork the repo
  • Make a new branch off main
  • Make changes
  • Run doit
  • Push to your fork
  • Start the pull request
    • your git CLI should offer you a link, as will the GitHub web UI
    • reference one or more issue so those that are interested can find your work
      • adding magic strings like fixes #123 help tie the collaboration history together
  • Wait for continuous integration
    • If stuff breaks, fix it or ask for help!

Previews

Each pull request is built and deployed on ReadTheDocs. You can view the live preview site by clicking on the ReadTheDocs check:

rtd-pr-preview

Artifacts

Additionally, several build artifacts are available from the each run on the Actions page, including:

  • test reports
  • installable artifacts
  • an app archive ready to be used as the input to the jupyter lite CLI with all the demo content and supporting extensions.

You must be logged in to GitHub to download these.

Releasing

TBD: See #121.