aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexis M <alexis@notmyidea.org>2019-10-14 19:59:00 +0200
committerAlexis Metaireau <alexis@notmyidea.org>2019-10-14 21:20:38 +0200
commit94e83306c344c47d49a5dc440df6d10d9a007172 (patch)
tree502a07a4a288b4fc165b6248a585fa84eafe4ee8
parent1730560d2004d3c9fc0f5cc971b7c3ab02783dac (diff)
downloadihatemoney-mirror-94e83306c344c47d49a5dc440df6d10d9a007172.zip
ihatemoney-mirror-94e83306c344c47d49a5dc440df6d10d9a007172.tar.gz
ihatemoney-mirror-94e83306c344c47d49a5dc440df6d10d9a007172.tar.bz2
Add instructions on how to run black in the contributing guide
-rw-r--r--docs/contributing.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 7635d1b..9d824aa 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -97,7 +97,16 @@ a pull request as it will help us to maintain the code clean and running.
To do so::
- $ make test
+ make test
+
+We are using the `black <https://black.readthedocs.io/en/stable/>`_ formatter
+for all the python files in this project. Be sure to run it locally on your
+files. To do so, just run::
+
+ black ihatemoney
+
+You can also integrate it with your dev environment (as a *format-on-save*
+hook, for instance).
As a designer / Front-end developer
-----------------------------------