Contributing to DESDEO

June 15, 2026 · View on GitHub

Thank you for your interest in contributing to DESDEO! Contributions of all kinds are welcome: bug reports, bug fixes, new features, new interactive methods, documentation improvements, and more.

This file is a short overview. The full, detailed contribution guide lives in the documentation:

Contributing to DESDEO (source: docs/tutorials/contributing.md)

The full guide covers, step by step: installing the required software, setting up a development environment with uv, the fork, branch, and pull request workflow, code style and linting (ruff, mypy), running the test suite, pre-commit hooks, docstring conventions, and building the documentation.

Quick start for contributors

Fork the repository and clone your fork.
Set up a development environment and install all dependencies:
```
uv sync
```
(uv also installs the just task runner used below.)
Create a feature branch off master.
Make your changes, keeping commits focused and well described.
Run the test suite:
```
just test
```
Run just --list to see all available recipes.
Push your branch and open a pull request against master.

Reporting issues and getting help

Found a bug? Open a bug report.
Have an idea or feature request? Open an idea discussion.
Need help or want to discuss? Join our Discord server.

Code of Conduct

By participating in this project you agree to abide by our Code of Conduct.