chore(pre-commit): update configuration and remove isort

Author: zoola969

.pre-commit-config.yaml

@@ -17,10 +17,6 @@ repos:
       - id: trailing-whitespace
       - id: no-commit-to-branch
         args: [ --branch, master ]
-  - repo: https://github.com/pycqa/isort
-    rev: 9.0.0a3
-    hooks:
-      - id: isort
   - repo: https://github.com/asottile/add-trailing-comma
     rev: v4.0.0
     hooks:
@@ -30,13 +26,16 @@ repos:
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix ]
-  - repo: https://github.com/psf/black
-    rev: 26.5.1
-    hooks:
-      - id: black
+      - id: ruff-format
   - repo: https://github.com/pappasam/toml-sort
     rev: v0.24.4
     hooks:
       - id: toml-sort
         entry: toml-sort
         args: [ pyproject.toml ]
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.4.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test]

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing
+
+## Setup
+
+```bash
+# Install all dependency groups (dev, docs, test)
+uv sync
+
+# Install pre-commit hooks
+uv run pre-commit install --hook-type pre-commit --hook-type commit-msg
+```
+
+## Development workflow
+
+```bash
+# Run tests
+uv run pytest
+
+# Run a single test file
+uv run pytest tests/test__decorator.py
+
+# Type checking
+uv run mypy cachium
+
+# Run coverage
+uv run coverage run -m pytest && uv run coverage report
+
+# Lint and format manually (pre-commit also runs these)
+uv run ruff check --fix cachium tests
+uv run ruff format cachium tests
+```
+
+## Commit messages
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/). The `commit-msg` pre-commit hook enforces this automatically.
+
+Format: `<type>(<optional scope>): <description>`
+
+Allowed types: `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test`
+
+Examples:
+```
+feat: add Redis storage backend
+fix: prevent dog-pile under high concurrency
+docs: add CacheWith usage example
+chore: bump ruff to v0.16
+```
+
+Breaking changes: append `!` after the type or add `BREAKING CHANGE:` in the footer.
+
+## Pre-commit hooks
+
+The following hooks run on every commit:
+
+| Hook | Purpose |
+|------|---------|
+| `check-added-large-files` | Prevent accidental large file commits |
+| `check-json`, `check-yaml`, `check-toml` | Validate config files |
+| `check-merge-conflict` | Catch unresolved merge conflict markers |
+| `detect-private-key` | Block accidental secret commits |
+| `end-of-file-fixer`, `trailing-whitespace` | Normalize whitespace |
+| `no-commit-to-branch` | Block direct commits to `master` |
+| `add-trailing-comma` | Enforce trailing commas |
+| `ruff` | Lint and auto-fix Python code (includes import sorting) |
+| `ruff-format` | Format Python code |
+| `toml-sort` | Keep `pyproject.toml` keys sorted |
+| `conventional-pre-commit` | Enforce conventional commit message format (commit-msg stage) |
+
+## Pull requests
+
+- Direct pushes to `master` are blocked; open a PR instead.
+- PRs should be small and focused. One logical change per PR.
+- All CI checks (tests, type checking, pre-commit) must pass before merging.
+
+## Extending the library
+
+See [CLAUDE.md](CLAUDE.md) / [AGENTS.md](AGENTS.md) for the architecture overview and guidance on adding new storage backends, serializers, and key builders.

cachium/storages/ttl_map.py

@@ -43,7 +43,6 @@ def __init__(self) -> None:
     def register_lock(self, key: TCacheKey, id_: int, timeout: float | None) -> None:
         deadline = time.monotonic() + timeout if timeout is not None else None
         with self._condition:
-
             while key in self._locks:
                 logger.debug("Key '%s' is in use, waiting for release.", key)
                 wait_time = deadline - time.monotonic() if deadline is not None else None
@@ -71,7 +70,6 @@ def __init__(self) -> None:
 
     async def register_lock(self, key: TCacheKey, id_: int, timeout: float | None) -> None:
         async with self._condition:
-
             while key in self._locks:
                 logger.debug("Key '%s' is in use, waiting for release.", key)
                 try:

pyproject.toml

@@ -75,13 +75,6 @@ omit = [
 [tool.hatch.version]
 source = "uv-dynamic-versioning"
 
-[tool.isort]
-float_to_top = true
-include_trailing_comma = true
-line_length = 120
-multi_line_output = 3
-use_parentheses = true
-
 [tool.mypy]
 strict = true
 
@@ -117,6 +110,7 @@ fixable = ["ALL"]
 ignore = [
     "A003",  # Class attribute {name} is shadowing a python builtin
     "AIR",  # airflow
+    "COM812",  # conflicts with ruff-format trailing comma management
     "CPY",  # flake8-copyright
     "D100",  # Missing docstring in public module
     "D104",  # Missing docstring in public package

tests/test__ttl_map_storage.py

@@ -284,7 +284,7 @@ def test_ttl_map_storage_max_size(max_size: int, keys_to_add: list[str], expecte
 
     # Add all the keys
     for i, key in enumerate(keys_to_add):
-        storage.set(key, f"value{i+1}")
+        storage.set(key, f"value{i + 1}")
 
     # Count the number of keys that are still in the cache
     keys_in_cache = 0