diff --git a/CONTRIBUTE.html b/CONTRIBUTE.html index c0e662bab..b81d27a48 100644 --- a/CONTRIBUTE.html +++ b/CONTRIBUTE.html @@ -186,12 +186,22 @@
MALA uses 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
pre-commit
. 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
.