docs: add pre-commit and add dev instructions in README

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.3.3
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.1.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []

README.md

@@ -10,3 +10,21 @@
 ## Installation
 
 Released version: `pip install replete`
+
+## Development
+
+- Install dev dependencies: `pip install -e ".[dev]"`
+- For linting and basic fixes [ruff](https://docs.astral.sh/ruff/) is used: `ruff check . --fix`
+- This repository follows strict formatting style which will be checked by the CI.
+  - To format the code, use the [black](https://black.readthedocs.io) format: `black .`
+  - To sort the imports, user [isort](https://pycqa.github.io/isort/) utility: `isort .`
+- To test code, use [pytest](https://pytest.org): `pytest .`
+- This repository follows semantic-release, which means all commit messages have to follow a [style](https://python-semantic-release.readthedocs.io/en/latest/commit-parsing.html).
+  You can use tools like [commitizen](https://github.com/commitizen-tools/commitizen) to write your commits.
+- You can also use [pre-commit](https://pre-commit.com/) to help verify that all changes are valid.
+  Multiple hooks are used, so use the following commands to install:
+
+  ```bash
+  pre-commit install
+  pre-commit install --hook-type commit-msg
+  ```

pyproject.toml

@@ -14,7 +14,7 @@ dependencies = ["coloredlogs", "docstring-parser", "python-dateutil", "xxhash"]
 [project.optional-dependencies]
 testing = ["pytest<8", "pyyaml"]
 test = ["flaky", "pytest", "pytest-asyncio", "pytest-coverage", "replete[testing]", "types-python-dateutil", "types-xxhash"]
-dev = ["replete[test]", "ruff"]
+dev = ["black", "isort", "replete[test]", "ruff"]
 
 [project.entry-points.pytest11]
 replete = "replete.testing"
@@ -31,6 +31,14 @@ minversion = "6.0"
 addopts = "--doctest-modules --no-success-flaky-report"
 asyncio_mode = "auto"
 
+[tool.black]
+line-length = 120
+# skip-magic-trailing-comma = true
+
+[tool.isort]
+profile = "black"
+line_length = 120
+
 [tool.yamlfix]
 line_length = 120
 section_whitelines = 1