feat: pre-commit config file

[BaptisteCecconi]

In order to ease the preparation of contribution, it would be good to use pre-commit, so that code checks can be done automatically before the the PR merge checks.

I see that black and pylint are used in the ci-cd.yml file, so I included them in my pre-commit config file.

I will propose a .pre-commit-config.yml in the next PR.

[clnsmth]

Great idea @BaptisteCecconi. I will need some time to read up on this and test it out before integrating into the system.

[clnsmth]

Note

This uses: https://github.com/pre-commit/pre-commit-hooks?tab=readme-ov-file

A potential configuration for this project (provided by @BaptisteCecconi):

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v5.0.0
  hooks:
  - id: check-yaml
  - id: end-of-file-fixer
    exclude: .*\.json$
  - id: trailing-whitespace
- repo: https://github.com/psf/black
  rev: 23.7.0
  hooks:
  - id: black
- repo: local
  hooks:
  - id: pylint
    name: pylint
    entry: pylint
    language: system
    types: [python]
    require_serial: true
    args:
      [
        "--exit-zero",
        "--disable=C0103,W0621,R0904"
      ]

[BaptisteCecconi]

The pre-commit tool is configured as follows:

• run pip install pre-commit in your local environment.
• then run pre-commit install to set up the git hook scripts.

(see https://pre-commit.com for more details)

This way, anytime you issue a git commit, the pre-commit tool will validate the files, and update them if necessary. If files have been edited by the pre-commit tool (e.g., removed end-of-line whitespaces, as suggested by black rules), the commit is not done. You may check the changes before running the commit on the updated files again.

The proposed config file proposes the same options as those selected in the current ci-cd.yml file.

[clnsmth]

This has been merged into the feature branch precommit-config-224 for further testing.