CONTRIBUTING

Please follow the github workflow. Create a ticket and/or branch. Create a pull-request.

See github Documentation for further information. We follow the Semantic Version Scheme.

Local Development

Please install these tools:

Run auto-formatting, linting, tests and documentation build:

uv run inv all

See uv run inv --list for any further details.

The project contains these files and directories:

File/Directory	Description
`src/`	Python Package Sources - the files this is all about
`pyproject.toml`	Python Package Meta File. Also contains all tool settings
`task.py`	Invoke tasks.py file
`.gitignore`	Lists of files and directories ignored by version control system
`.github/`	Github Settings
`.readthedocs.yaml`	Documentation Server Configuration
`.pre-commit-config.yaml`	Pre-Commit Check Configuration
`uv.lock`	File with resolved python package dependencies

Next to that, there are some temporary files ignored by version control system.

File/Directory	Description
`htmlcov/`	Test Execution Code Coverage Report in HTML format
`report.xml`	Test Execution Report
`.venv`	Virtual Environments