Contributing#

This document outlines development instructions and guidelines for new contributors.

Prerequisites#

Create environment:

conda env create -f environment.yaml

Activate environment:

conda activate jupyterhub-ai-gateway

Check package style:

pre-commit run --all-files

Install pre-commit (optional):

pre-commit install

Test package:

pytest tests/

Build and run documentation:

sphinx-autobuild --port 3000 docs/ docs/build/html/

Note See also the Makefile for development.