From bb4ecfe56e1ace9ea9e2934ed19816f165a4ecb4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20P=C3=A9ters?= <fpeters@entrouvert.com>
Date: Wed, 13 Jan 2021 17:39:30 +0100
Subject: [PATCH] misc: add black files/notes

---
 .git-blame-ignore-revs  |  2 ++
 .pre-commit-config.yaml |  8 ++++++++
 README                  | 11 +++++++++++
 3 files changed, 21 insertions(+)
 create mode 100644 .git-blame-ignore-revs
 create mode 100644 .pre-commit-config.yaml

diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
new file mode 100644
index 0000000..44f7cb0
--- /dev/null
+++ b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# trivial: apply black
+8089f03e4ab1432e705c2fba8706a0ea79dd8bbe
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..a14705c
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,8 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    - id: black
+      args: ['--target-version', 'py37', '--skip-string-normalization', '--line-length', '110']
diff --git a/README b/README
index 530d5a6..87750af 100644
--- a/README
+++ b/README
@@ -23,6 +23,17 @@ CUT_GNM_OU_MAPPING
   }
 
 
+Code Style
+----------
+
+black is used to format the code, using thoses parameters:
+
+    black --target-version py37 --skip-string-normalization --line-length 110
+
+There is .pre-commit-config.yaml to use pre-commit to automatically run black
+before commits. (execute `pre-commit install` to install the git hook.)
+
+
 License
 -------