CONTRIBUTING.md

# Contributing

Please contribute your features to this repository. You should ideally do this with a new branch and ask a user with write permissions to review and merge. If you are a user with write permissions, please ask another user with write permissions to review and merge.

## Formatting

It is recommended that you use `ruff` to format your code. This will follow the conventions within the `pyproject.toml` file.

`ruff` can be found at [https://github.com/astral-sh/ruff](https://github.com/astral-sh/ruff)

## Tests

Please write tests for your code, add these to the `test` directory. I use `pytest` to do testing.

## Issues

Please file issues as they arise. Describe the problem, the steps to reproduce, and provide any output.