Add precommit hooks for ruff

.github/workflows/test.yml

@@ -30,8 +30,13 @@ jobs:
           pip install poetry
 
       - name: Install dependencies & ucc
-        run: |
-          poetry install
+        run: poetry install
+
+      - name: Run linter
+        run: poetry run ruff check
+
+      - name: Run formatter check
+        run: poetry run ruff format --check
 
       - name: Run tests
         run: poetry run pytest ucc --verbose

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version (keep in sync with the version in pyproject.toml)
+  rev: v0.9.4
+  hooks:
+    # Run the linter first, as fixing will change files that need to be
+    # formatted after
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

docs/source/contributing.rst

@@ -13,7 +13,7 @@ The rest of this document describes the technical details of getting set up to d
 Setting up your development environment
 ---------------------------------------
 
-We leverage `poetry <https://python-poetry.org/>` for packaging and dependency management. 
+We leverage `poetry <https://python-poetry.org/>` for packaging and dependency management.
 After installing poetry, run the following commands to clone the repository, create a poetry managed virtual environment for development, and install dependencies.
 
 .. code:: bash
@@ -37,6 +37,13 @@ and build the documentation by changing to the ``docs/source`` directory where y
 
 The built documentation will then live in ``ucc/docs/source/_build/html``.
 
+We also use `pre-commit <https://pre-commit.com/>` to run code formatting and linting checks before each commit.
+To enable the pre-commit hooks, run
+
+.. code:: bash
+
+    pre-commit install
+
 .. tip::
 
     Remember to run the tests and build the documentation before opening a pull request to ensure a smoother pull request review.

pyproject.toml

@@ -28,6 +28,7 @@ packages = [{include = "ucc"}]
 pytest = ">=6.0"
 pytest-cov = ">=2.10"
 ruff = "^0.9.4"
+pre-commit = "^4.1.0"
 
 [tool.poetry.group.doc.dependencies]
 sphinx = ">=8.1.3"