contributing to yabplot

thank you for your interest in contributing to yabplot! we welcome contributions from the neuroimaging and open-source communities.

how to contribute

use the github issue tracker to report bugs.
include a minimal reproducible example and information about your environment (os, python version, package versions).

open an issue describing the proposed feature and why it would be useful for the community.

fork the repository and create your branch from main.
if you've added code that should be tested, add tests in the tests/ directory.
if you've changed API, update the documentation.
ensure the test suite passes: uv run pytest tests/
submit a pull request with a clear description of the changes.

we use uv for dependency management. to set up your development environment:

git clone https://github.com/teanijarv/yabplot.git
cd yabplot
uv venv
uv pip install -e ".[docs]"
uv pip install pytest

by contributing, you agree to abide by our code of conduct.