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

---
 .git-blame-ignore-revs  |  2 ++
 .pre-commit-config.yaml |  8 ++++++++
 README                  | 12 ++++++++++++
 3 files changed, 22 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..505921d
--- /dev/null
+++ b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# trivial: apply black
+ce7f2dd5000cf1eb462ae18aeeb5ab66913b452f
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 a6c5eda..405e4b2 100644
--- a/README
+++ b/README
@@ -36,6 +36,18 @@ Tests
     pip install pytest pytest-django pytest-mock
     DJANGO_SETTINGS_MODULE=welco.settings py.test tests/
 
+
+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
 -------