Add prek and pre-commit hooks

.github/workflows/docs.yml

@@ -24,9 +24,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/configure-pages@v6
-      
+
       - uses: actions/checkout@v6
-      
+
       - name: Install uv
         uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
@@ -40,10 +40,10 @@ jobs:
         run: uv sync --locked --all-extras --dev
 
       - run: uv run zensical build --clean
-      
+
       - uses: actions/upload-pages-artifact@v5
         with:
           path: site
-  
+
       - uses: actions/deploy-pages@v5
         id: deployment

.github/workflows/python-release.yaml

@@ -27,7 +27,7 @@ jobs:
 
       - name: Build
         run: uv build
-      
+
       # Check that basic features work and we didn't miss to include crucial files
       - name: Smoke test (wheel)
         run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py

.github/workflows/python-test.yaml

@@ -41,7 +41,7 @@ jobs:
 
       - name: Test with pytest
         run: uv run pytest -vv --cov-report term-missing --cov-report xml --cov isku
-    
+
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v6
         with:
@@ -66,7 +66,7 @@ jobs:
 
       - name: Build
         run: uv build
-      
+
       # Check that basic features work and we didn't miss to include crucial files
       - name: Smoke test (wheel)
         run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py

.gitignore

@@ -197,9 +197,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
 #   you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 # Temporary file for partial code execution

CHANGELOG.md

@@ -11,10 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Documentation in docs/ hosted at brews.github.io/isku.
 - Test and test-coverage badges to README.
+- Add pre-commit hooks (via prek) to help developers with format.
 
 ### Changed
 
 - Improved README.
+- Improved CONTRIBUTING.
 - Add project URLs to package metadata.
 
 ## [0.1.0] - 2026-05-06

CONTRIBUTING.md

@@ -31,7 +31,7 @@ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to
 
 isku could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
 
-PRs with small corrections to spelling, format or clarity are welcome. The project has designed its documentation to make this process easier for non-technical users to contribute to documentation. 
+PRs with small corrections to spelling, format or clarity are welcome. The project has designed its documentation to make this process easier for non-technical users to contribute to documentation.
 
 ### Submit Feedback
 
@@ -70,10 +70,10 @@ Then, install and activate the environment with:
 uv sync
 ```
 
-4. Install pre-commit to run linters/formatters at commit time:
+4. Install prek to run linters/formatters at commit time:
 
 ```bash
-uv run pre-commit install
+uv run prek install --prepare-hooks
 ```
 
 5. Create a branch for local development:
@@ -86,21 +86,18 @@ Now you can make your changes locally.
 
 6. Don't forget to add test cases for your added functionality to the `tests` directory.
 
-7. When you're done making changes, check that your changes pass the formatting tests.
+7. When you're done making changes, check that your changes pass the lint tests.
 
 ```bash
 just lint
 ```
 
-Now, validate that all unit tests are passing:
+Now, validate that automated tests are passing:
 
 ```bash
 just test
 ```
 
-This requires you to have multiple versions of python installed.
-This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.
-
 9. Commit your changes and push your branch to GitHub:
 
 ```bash

docs/faq.md

@@ -1,5 +1,4 @@
 # FAQ
 
-!!! warning 
+!!! warning
     :lucide-construction: This page is under construction.
-

docs/index.md

@@ -1,6 +1,6 @@
 # Get Started
 
-!!! warning 
+!!! warning
     :lucide-construction: This page is under construction.
 
 
@@ -51,4 +51,3 @@ using `pip` or with a project in `uv`, do
 ```shell
 uv add git+https://github.com/brews/isku
 ```
-

docs/support.md

@@ -1,7 +1,6 @@
 # Support
 
-!!! warning 
+!!! warning
     :lucide-construction: This page is under construction.
 
 `isku` is open-source software made available under the terms of either the MIT License or the Apache License 2.0, at your option.
-

docs/user_guide.md

@@ -1,6 +1,6 @@
 # User Guide
 
-!!! warning 
+!!! warning
     :lucide-construction: This page is under construction.
 
 ### Projecting models
@@ -117,4 +117,3 @@ transformed = isku.extract_regions(
     regions=my_regions,
 )
 ```
-

prek.toml

@@ -0,0 +1,21 @@
+[[repos]]
+repo = "https://github.com/pre-commit/pre-commit-hooks"
+rev = "v6.0.0"
+hooks = [
+  { id = "check-case-conflict" },
+  { id = "check-merge-conflict" },
+  { id = "check-toml" },
+  { id = "check-yaml" },
+  { id = "end-of-file-fixer" },
+  { id = "trailing-whitespace" },
+  { id = "mixed-line-ending" },
+  { id = "debug-statements" },
+]
+
+[[repos]]
+repo = "https://github.com/astral-sh/ruff-pre-commit"
+rev = "v0.15.12"
+hooks = [
+  { id = "ruff-check", args = ["--fix", "--show-fixes"] },
+  { id = "ruff-format" },
+]

pyproject.toml

@@ -21,4 +21,8 @@ tests = [
   "ty>=0.0.34",
 ]
 docs = ["mkdocstrings[python]>=1.0.4", "zensical>=0.0.41"]
-dev = [{ include-group = "docs" }, { include-group = "tests" }]
+dev = [
+    { include-group = "docs" },
+    { include-group = "tests" },
+    "prek>=0.3.13",
+]