Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 727 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 727 Bytes

Contribution guide

This project is open source. All contributions are welcome.

Set up development environment

This project uses uv for package and tool management and nox to define tasks, such as building the docs or running tests.

To install nox with uv, run:

uv tool install nox

Run sessions

To list the available sessions, run: nox -ls. To run a specific session, run: {samp}nox -s {SESSION}, append -p 3.13 to run the session only with the latest supported Python version.

For example, to build the docs with Python 3.13 and start a server for a live preview, run:

nox -s docs -p 3.13 -- --live