misc: add black files/notes

This commit is contained in:
Frédéric Péters 2021-01-11 21:32:33 +01:00
parent 2d00832fc2
commit d51a64b9da
3 changed files with 21 additions and 0 deletions

2
.git-blame-ignore-revs Normal file
View File

@ -0,0 +1,2 @@
# trivial: apply black
2d00832fc216df36d665d05a16732030ee48f641

8
.pre-commit-config.yaml Normal file
View File

@ -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']

11
README
View File

@ -5,6 +5,17 @@ Extension module for the combo content management system, with various
developments that are at the moment at least specific to the GNM project. developments that are at the moment at least specific to the GNM project.
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 License
------- -------