Pre-commit tool

To ensure an easy to use way of software quality tools, we are using pre-commit.

In this way we ensure the same level of quality checks in CI and for local development. For all repositories used by SimpleCore™ the same configuration is rolled out and used.

Install pre-commit

On your PC run

pip install pre-commit

Setup pre-commit

Once installed, you can setup pre-commit to automatically check at the time a commit is made. In the repository run

pre-commit install

alternatively you can run the checks manually

pre-commit run -a

Applied checks

Currently the following checks are performed by the project’s configuration

• shell script linting with shellcheck

• python linting with flake8

• python docstring linting with pydocstyle

• rST document linting with rstcheck

• bitbake recipe linting with oelint-adv

• secrets vetting with The detect-secrets tool

• CI pipeline linting with actionlint

• license metadata checks with reuse

• project specific lints with relint