Contributing#

Thank you for your interest in contributing to casanovoutils! We welcome bug reports, feature requests, documentation improvements, and code contributions.

Reporting issues#

Please open an issue on GitHub and include:

A clear description of the problem or request.
Steps to reproduce the issue (for bugs).
The versions of casanovoutils and Python you are using.

Setting up a development environment#

Clone the repository and install the package with development dependencies using uv:

git clone https://github.com/Noble-Lab/casanovoutils.git
cd casanovoutils
uv sync --group dev

Running the tests#

uv run pytest tests/

Code style#

casanovoutils uses black for formatting and isort for import ordering. Before submitting a pull request, please run:

uv run isort src/ tests/
uv run black src/ tests/

Submitting a pull request#

Fork the repository and create a feature branch from main.
Make your changes and add tests where appropriate.
Ensure all tests pass and the code is formatted.
Open a pull request against main with a clear description of the changes.

Building the documentation#

Install the documentation dependencies and build locally:

pip install -e ".[docs]"
cd docs
make html

Or with uv:

uv sync --extra docs
cd docs
make html

The built documentation will be in docs/_build/html/.

Contributing

Contents