Contributing

Contributions are welcome.

If Orthority is useful to you, please consider making a donation to fund its development.

Bug reports and feature requests can be made with the github issue tracker. Funded requests will be prioritised.

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 -e .[tests]

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

Please work on features in a new branch, and submit your changes as a GitHub pull request for review. I recommend discussing possible pull requests in an issue beforehand.

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