The jupyter_rfb contributor guide

This page is for those who plan to hack on jupyter_rfb or make other contributions.

How can I contribute?

Anyone can contribute to jupyter_rfb. We strive for a welcoming environment - see our code of conduct.

Contribution can vary from reporting bugs, suggesting improvements, help improving documentations. We also welcome improvements in the code and tests. We uphold high standards for the code, and we’ll help you achieve that.

Install jupyter_rfb in development mode

$ git clone https://github.com/vispy/jupyter_rfb.git
$ cd jupyter_rfb
$ pip install -e .[dev]

When actively developing the JavaScript code, install the standardjs linter/formatter:

$ npm install --global standard

Automated tools

To make it easier to keep the code valid and clean, we use the following tools:

• Run ruff format to autoformat the code.

• Run ruff check for linting and formatting checks.

• Run standard src --fix to autoformat and lint the JavaScript code.

Autocommit hook

Optionally, you can setup an autocommit hook to automatically run these on each commit:

$ pip install pre-commit
$ pre-commit install

Tips to test changes made to code

In general you should not have to restart the server when working on the code of jupyter_rfb:

• When Python code has changed: restart and clear all outputs.

• When the JavaScript code has changed: clear outputs, save, and then refresh (F5) the page.