add pre commit hook to run format tests (#118)

Author: aleivag

.github/workflows/ci.yml

@@ -45,6 +45,10 @@ jobs:
           e2e
     - name: Run isort
       uses: isort/isort-action@v1
+    - name: Formatting hint
+      if: failure()
+      run: |
+        echo "::notice::PROTIP: You can install pre-commit hooks to automatically format your code before each commit. Run 'uv run pre-commit install' and never have to resubmit a PR because of formatting errors! See CONTRIBUTING.md for more details."
 
 
   typing:

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+        files: ^(pystemd|examples|tests|e2e)/
+      - id: ruff-format
+        files: ^(pystemd|examples|tests|e2e)/
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.0
+    hooks:
+      - id: isort

CONTRIBUTING.md

@@ -6,6 +6,61 @@ possible.
 We use GitHub issues to track public bugs. Please ensure your description is
 clear and has sufficient instructions to be able to reproduce the issue.
 
+## Development setup
+
+### Prerequisites
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) if you don't have it already:
+
+
+### Installing dependencies
+After cloning the repository, install the development dependencies:
+
+```bash
+uv sync --all-extras
+```
+
+### Running tests
+Run the unit tests with:
+
+```bash
+uv run pytest tests
+```
+
+Or with coverage:
+
+```bash
+uv run pytest --cov=pystemd tests
+```
+
+### Running E2E tests
+The E2E tests run in a systemd container using mkosi and are primarily designed
+for CI. To run them locally, you need `mkosi` and `systemd-container` installed.
+See `.github/workflows/e2e-tests.yml` for the full setup. For most contributions,
+unit tests are sufficient.
+
+### Formatting code
+Format your code before submitting a pull request:
+
+```bash
+uv run ruff check --fix pystemd examples tests e2e
+uv run ruff format pystemd examples tests e2e
+uv run isort .
+```
+
+### Type checking
+We use [pyrefly](https://github.com/facebook/pyrefly) for type checking. Run it with:
+
+```bash
+uv run pyrefly check pystemd examples tests
+```
+
+Optionally, you can install pre-commit hooks to automatically format code on
+each commit:
+
+```bash
+uv run pre-commit install
+```
+
 ## Sending a pull request
 Have a fix or feature? Awesome! When you send the pull request we suggest you
 include a build output.

pyproject.toml

@@ -46,6 +46,7 @@ lint = [
     "ruff",
     "pyrefly",
     "isort",
+    "pre-commit",
 ]
 
 [project.urls]