Pre-commit

[rpartzsch]

Perhaps it makes sense to implement pre-commit hooks. I would propose to use black or ruff for formatting and perhaps also implement a spellchecker. Running codespell on basil gives some funny responses. This would also solve #113.

For aidatlu the following pre-commit hook is used:

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v5.0.0
    hooks:
    -   id: check-yaml
    -   id: end-of-file-fixer
    -   id: trailing-whitespace

-   repo: https://github.com/psf/black
    rev: 24.10.0
    hooks:
    -   id: black

-   repo: https://github.com/codespell-project/codespell
    rev: v2.3.0
    hooks:
    -   id: codespell

[cbespin]

I think at least the bare minimum that a repo should have is the end-of-file-fixer, trailing-whitespace and check-yaml / check-toml (but we do not use toml here). Formatting is a different topic and highly opinionated, but I am open to that.

[rpartzsch]

I think a common format enhances code readability. There is also an flake8 test in the CI. Updating this test to ruff is in general a good idea in my opinion. In addition, giving people the opportunity to format using pre-commits makes development easier.

Code spell is a lot of work, but could prevent errors like generic_fifo in the future (see also v4.0 tasks).

[cbespin]

Agreed. Do you want to implement those? Maybe already using ruff instead of black, and leaving out codespell for now (as it is a lot of work, like you said)?