CONTRIBUTING.md

Contributing

Thank you for considering a contribution to jupyterlite-pyodide-lock.

We use pixi for local development and GitHub issues and pull requests to collaboration.

Pull Requests

Before making a pull request, please ensure:

• you've got a local setup
• the following command runs without error:

pixi run pr

Local Development

Set Up

This project is developed locally and in CI with pixi, a relatively new approach to conda package management and task running.

Note

Refer to pixi.toml#/$schema for the current development version

If using mamba or conda (or some other $CONDA_EXE):

mamba install -c conda-forge "pixi ==0.40.3"  # replace `mamba` with your CONDA_EXE

Why pixi?

pixi provides the necessary primitives to:

• capture complex environments, with python and other runtimes
• install environments quickly, and cache well, but only when needed
• run tasks, in the right environment, in the right order
• skip tasks that have already run, and dependencies have not changed

Tasks and Environments

See all the project info:

pixi info

See the available top-level pixi tasks:

pixi task list

Running Tasks

Most tasks run just fine, and then stop:

pixi run all     # does all of the following, as needed
pixi run fix
pixi run build
pixi run lint
pixi run docs
pixi run check
pixi run test   # this takes a pretty long time

Some tasks run until stopped with ctrl+c:

pixi run serve-lab
pixi run serve-docs