style: improve the CI code

.github/workflows/on-pr-against-dev.yaml

@@ -45,11 +45,11 @@ jobs:
         with:
           junitxml-path: ./pytest-junit.xml
           pytest-xml-coverage-path: ./coverage.xml
-      - name: Run Black style check on source code
-        run: black --check ./src ./tests
-      - name: Run isort import organizer on source code
+      - name: Run isort to check Python import order
         run: isort --check --profile black ./src ./tests
-      - name: Run Flake8 linter
+      - name: Run Black to check the Python code style and quality
+        run: black --check ./src ./tests
+      - name: Run Flake8 to check the Python code style and quality
         run: flake8 ./src ./tests
 
 # ===================================================================================== #

.github/workflows/on-pr-against-main.yaml

@@ -45,11 +45,11 @@ jobs:
         with:
           junitxml-path: ./pytest-junit.xml
           pytest-xml-coverage-path: ./coverage.xml
-      - name: Run Black style check on source code
-        run: black --check ./src ./tests
-      - name: Run isort import organizer on source code
+      - name: Run isort to check Python import order
         run: isort --check --profile black ./src ./tests
-      - name: Run Flake8 linter
+      - name: Run Black to check the Python code style and quality
+        run: black --check ./src ./tests
+      - name: Run Flake8 to check the Python code style and quality
         run: flake8 ./src ./tests
 
 # ===================================================================================== #

.github/workflows/on-push-to-dev.yaml

@@ -40,11 +40,11 @@ jobs:
       - name: Run unit tests with pytest
         # pytest-coverage.txt is required to properly report coverage in README.md.
         run: pytest | tee ./pytest-coverage.txt
-      - name: Run Black style check on source code
-        run: black --check ./src ./tests
-      - name: Run isort import organizer on source code
+      - name: Run isort to check Python import order
         run: isort --check --profile black ./src ./tests
-      - name: Run Flake8 linter
+      - name: Run Black to check the Python code style and quality
+        run: black --check ./src ./tests
+      - name: Run Flake8 to check the Python code style and quality
         run: flake8 ./src ./tests
       - name: Generate unit test coverage report
         id: report-coverage

.github/workflows/on-push-to-main.yaml

@@ -40,11 +40,11 @@ jobs:
       - name: Run unit tests with pytest
         # pytest-coverage.txt is required to properly report coverage in README.md.
         run: pytest | tee ./pytest-coverage.txt
-      - name: Run Black style check on source code
-        run: black --check ./src ./tests
-      - name: Run isort import organizer on source code
+      - name: Run isort to check Python import order
         run: isort --check --profile black ./src ./tests
-      - name: Run Flake8 linter
+      - name: Run Black to check the Python code style and quality
+        run: black --check ./src ./tests
+      - name: Run Flake8 to check the Python code style and quality
         run: flake8 ./src ./tests
       - name: Generate unit test coverage report
         id: report-coverage

.pre-commit-config.yaml

@@ -15,14 +15,14 @@ repos:
     - id: mixed-line-ending
     - id: trailing-whitespace
       files: \.(py|rst|sh|yaml|yml)$
+- repo: https://github.com/PyCQA/isort
+  rev: 5.13.2
+  hooks:
+    - id: isort
 - repo: https://github.com/psf/black
   rev: 23.7.0
   hooks:
   - id: black
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.2
-  hooks:
-    - id: isort
 - repo: https://github.com/PyCQA/flake8
   rev: 6.1.0
   hooks: