Contributing

Contributions are welcome.

If Orthority is useful to you, please consider supporting its development and maintenance with a donation.

Bug reports and feature requests can be made with the GitHub issue tracker.

Development

To set up a development environment, start by cloning a fork of the repository:

git clone https://github.com/<username>/orthority
cd orthority

If installing with pip, you can install dependencies and link the repository into your environment with:

pip install --group tests -e .

If installing into a conda environment, it is best to install the dependencies with conda first, before running:

pip install --no-deps -e .

Please work on features in a new branch, and submit your changes as a GitHub pull request for review.

Orthority uses Ruff for linting and formatting (with settings in pyproject.toml), and the RST docstring style. Please include pytest unit tests with your code.