Add pre-commit to dependencies with appropriate config (#892)

* Add pre-commit to dependencies with appropriate config

* Add isort to pre-commit configuration

* loosens pre-commit python version requirement

* Update documentation to present pre-commit hooks

* Updates documentation to present formatting convention

* Update installation instructions and guides for pre-commit

* Language edit for the CLIMADA conventions guide.

* Language edit for the CLIMADA conventions guide.

* Apply suggestions from code review

---------

Co-authored-by: spjuhel <[email protected]>
Co-authored-by: Pui Man (Mannie) Kam <[email protected]>
Co-authored-by: emanuel-schmid <[email protected]>

Author: 4 people

.gitignore

@@ -176,3 +176,10 @@ data/ISIMIP_crop/
 
 # climada data results folder:
 results/
+
+# Hidden files we want to track
+!.gitignore
+!.pre-commit-config.yaml
+!.pylintrc
+!.readthedocs.yml
+!.github

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# See https://pre-commit.com for more information
+default_language_version:
+  python: python3
+
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/pycqa/isort
+    rev: '5.13.2'
+    hooks:
+      - id: isort
+        args: ["--profile", "black", "--filter-files"]
+
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: '24.4.2'
+    hooks:
+      - id: black-jupyter