Contributing

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to honor this code.

Getting started

This project uses uv for packaging. To get set up:

Fork the repository.
Clone the repository.
Install uv.
From the repository directory, run tests, which will also install packages:
```
uv run pytest --cov
```

Fork this repository
Create a branch: git checkout -b my_feature
Make changes
Run uvx ruff check to run static analysis.
Run uvx ruff format to ensure that your changes conform to the coding style of this project.
Commit: git commit -am "Great new feature that closes #3". Reference any related issues in the first line of the commit message.
Push: git push origin my_feature
Open a pull request
Pat yourself on the back for making an open source contribution :)

Please review the open issues before opening a PR.
Significant changes or new features should be documented in the README.
Writing tests is never a bad idea. Make sure all tests are passing before opening a PR.