Add pre-commit hooks mirroring CI linting pipeline (#611)

* Initial plan

* Add pre-commit hooks configuration matching CI pipeline

Co-authored-by: pancetta <7158893+pancetta@users.noreply.github.com>

* Fix ruff pre-commit configuration to remove redundant check argument

Co-authored-by: pancetta <7158893+pancetta@users.noreply.github.com>

* Test pre-commit hooks with valid code

* Remove test file

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: pancetta <7158893+pancetta@users.noreply.github.com>

Author: Copilot

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# This pre-commit configuration matches the CI pipeline linting checks exactly.
+# The CI runs: black pySDC --check --diff --color and ruff check pySDC
+# Therefore, we only check files in the pySDC directory here.
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        args: [--check, --diff, --color]
+        language_version: python3
+        files: ^pySDC/
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        files: ^pySDC/

docs/contrib/02_continuous_integration.md

@@ -122,6 +122,27 @@ fi
 ```
 Don't forget to assign execution rights.
 
+### Using pre-commit hooks (Recommended)
+
+For a more robust and automated approach, you can use the [pre-commit](https://pre-commit.com/) framework, which manages git hooks for you. The repository includes a `.pre-commit-config.yaml` file that is configured to run the exact same linting checks as the CI pipeline.
+
+To set up pre-commit hooks:
+
+```bash
+# Install pre-commit (can also be done with conda/mamba or as part of pip install -e .[dev])
+pip install pre-commit
+
+# Install the git hooks
+pre-commit install
+
+# (Optional) Run against all files to check current state
+pre-commit run --all-files
+```
+
+Once installed, the hooks will automatically run `black` and `ruff` on staged files before each commit. The hooks are configured to check only files in the `pySDC` directory, matching exactly what the CI pipeline checks.
+
+> :bell: **Note:** The pre-commit hooks run in `--check` mode by default (same as CI), meaning they will prevent commits if formatting issues are found. You can fix formatting issues by running `black pySDC` directly, then staging and committing again.
+
 As a final note, make sure to regularly update linting related packages, as they constantly introduce checking of more PEP8 guidelines.
 This might cause the linting to fail in the GitHub action, which uses the most up to date versions available on the conda-forge channel, even though it passed locally.
 

pyproject.toml

@@ -51,7 +51,8 @@ dev = [
     'ruff',
     'pytest',
     'pytest-cov',
-    'sphinx'
+    'sphinx',
+    'pre-commit'
     ]
 
 [tool.pytest.ini_options]