Code practices

Committing

Contributions can be committed to the project via pull requests. The main branch will be locked shortly, allowing only commits that have been reviewed and pass all CI checks and tests.

Standard Python file header

We've agreed on using the following header for all python files:

# SPDX-License-Identifier: BSD-3-Clause
# /usr/bin/env python3
# -*- coding: utf-8 -*-

from __future__ import annotations

__coding__ = "utf-8"
__authors__ = ["Amaretto Contributor"]  # add names to the list as appropriate
__copyright__ = "Copyright 2025, The MoDaCor team"
__date__ = "14/06/2025"
__status__ = "Development"  # "Development", "Production"
# end of header and standard imports

pre-commit hooks

It is recommended to use the pre-commit python library to check all formatting and style rules, before committing to the Git repo. CI will also run these checks.