diff options
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 2a3af02..1ab6300 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -71,6 +71,10 @@ Coding Conventions * Follow `PEP-8 conventions <https://www.python.org/dev/peps/pep-0008/>`__ * NOTE: The only variation is that the line-length can be 88 characters vs. 80 +* All code must be formatted using the `Black <https://black.readthedocs.io/>`__ + code formatter. VVP uses the `pre-commit library <https://pre-commit.com/>`__ + to automatically format code at check-in. After running ``pip install``, + run ``pre-commit install`` to initialize the git hook. * Familiarize yourself with the utilities that exist in the following utility modules and leverage them to avoid duplication. |