deploy: 20ebf98

CONTRIBUTE.html

@@ -186,12 +186,22 @@ <h2>Developing code<a class="headerlink" href="#developing-code" title="Permalin
 </ul>
 <div class="section" id="formatting-code">
 <h3>Formatting code<a class="headerlink" href="#formatting-code" title="Permalink to this headline"></a></h3>
-<ul class="simple">
+<ul>
 <li><p>MALA uses <a class="reference external" href="https://github.com/psf/black"><code class="docutils literal notranslate"><span class="pre">black</span></code></a> for code formatting</p></li>
-<li><p>The <code class="docutils literal notranslate"><span class="pre">black</span></code> configuration is located in <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code></p></li>
+<li><p>The <code class="docutils literal notranslate"><span class="pre">black</span></code> configuration is located in <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code>, the <code class="docutils literal notranslate"><span class="pre">black</span></code> version
+is specified in <code class="docutils literal notranslate"><span class="pre">.pre-commit-config.yaml</span></code></p></li>
 <li><p>Currently, no automatic code reformatting will be done in the CI, thus
 please ensure that your code is properly formatted before creating a pull
-request</p></li>
+request. We suggest to use <a class="reference external" href="https://pre-commit.com/"><code class="docutils literal notranslate"><span class="pre">pre-commit</span></code></a>. You can</p>
+<ul class="simple">
+<li><p>manually run <code class="docutils literal notranslate"><span class="pre">pre-commit</span> <span class="pre">run</span> <span class="pre">-a</span></code> at any given time</p></li>
+<li><p>configure it to run before each commit by executing <code class="docutils literal notranslate"><span class="pre">pre-commit</span> <span class="pre">install</span></code>
+once locally</p></li>
+</ul>
+<p>Without <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code>, please install the <code class="docutils literal notranslate"><span class="pre">black</span></code> version named in
+<code class="docutils literal notranslate"><span class="pre">.pre-commit-config.yaml</span></code> and run <code class="docutils literal notranslate"><span class="pre">find</span> <span class="pre">-name</span> <span class="pre">&quot;*.py&quot;</span> <span class="pre">|</span> <span class="pre">xargs</span> <span class="pre">black</span></code> or just
+<code class="docutils literal notranslate"><span class="pre">black</span> <span class="pre">my_modified_file.py</span></code>.</p>
+</li>
 </ul>
 </div>
 <div class="section" id="adding-dependencies">

_sources/CONTRIBUTE.md.txt

@@ -93,10 +93,19 @@ the core development team.
 ### Formatting code
 
 * MALA uses [`black`](https://github.com/psf/black) for code formatting
-* The `black` configuration is located in `pyproject.toml`
+* The `black` configuration is located in `pyproject.toml`, the `black` version
+  is specified in `.pre-commit-config.yaml`
 * Currently, no automatic code reformatting will be done in the CI, thus
-  please ensure that your code is properly formatted before creating a pull 
-  request
+  please ensure that your code is properly formatted before creating a pull
+  request. We suggest to use [`pre-commit`](https://pre-commit.com/). You can
+
+  * manually run `pre-commit run -a` at any given time
+  * configure it to run before each commit by executing `pre-commit install`
+    once locally
+
+  Without `pre-commit`, please install the `black` version named in
+  `.pre-commit-config.yaml` and run `find -name "*.py" | xargs black` or just
+  `black my_modified_file.py`.
 
 ### Adding dependencies