docs: Improved README

Author: Alan Christie

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
 
 # Conventional Commit message checker (commitizen)
 - repo: https://github.com/commitizen-tools/commitizen
-  rev: v3.21.3
+  rev: v3.29.1
   hooks:
   - id: commitizen
     stages:
@@ -19,7 +19,7 @@ repos:
 
 # Standard pre-commit rules
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.1.0
+  rev: v5.0.0
   hooks:
   - id: check-case-conflict
   - id: check-docstring-first
@@ -32,17 +32,26 @@ repos:
   - id: trailing-whitespace
     args:
     - --markdown-linebreak-ext=md
+# isort (in black-compatibility mode)
+- repo: https://github.com/pycqa/isort
+  rev: 5.13.2
+  hooks:
+  - id: isort
+    args:
+    - --profile
+    - black
+    - --filter-files
 # Black (uncompromising) Python code formatter
 - repo: https://github.com/psf/black
-  rev: 24.3.0
+  rev: 24.10.0
   hooks:
   - id: black
     args:
     - --target-version
     - py312
 # MyPy
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.9.0
+  rev: v1.11.2
   hooks:
   - id: mypy
     files: ^workflow
@@ -56,7 +65,7 @@ repos:
   - id: yamllint
 # Pylint
 - repo: https://github.com/pycqa/pylint
-  rev: v3.1.0
+  rev: v3.3.1
   hooks:
   - id: pylint
     name: pylint

README.rst

@@ -31,6 +31,34 @@ formed from the definition YAML file) with:
 
 .. _PyPI: https://pypi.org/project/im-data-manager-workflow-decoder
 
+Contributing
+============
+
+The project's written in Python and uses `Poetry`_ for dependency and package
+management. We also use `pre-commit`_ to manage our pre-commit hooks, which
+rely on `black`_, `mypy`_, `pylint`_, amongst others.
+
+Create your enverionewmnt::
+
+    poetry shell
+    poetry install --with dev
+    pre-commit install -t commit-msg -t pre-commit
+
+And then start by running the pre-commit hooks to ensure you're stating with a
+_clean_ project::
+
+    pre-commit run --all
+
+And then running the tests::
+
+    pytest
+
+.. _Poetry: https://python-poetry.org
+.. _pre-commit: https://pre-commit.com
+.. _black: https://github.com/psf/black
+.. _mypy: https://github.com/python/mypy
+.. _pylint: https://pypi.org/project/pylint/
+
 Get in touch
 ============