From e1e4e93ba2d570070058aaec64d69ef3123f7303 Mon Sep 17 00:00:00 2001 From: "Lovett, Trevor" Date: Fri, 6 Sep 2019 15:39:21 -0500 Subject: [VVP] Documented usage of black code formatter Issue-ID: VVP-203 Change-Id: Ifc5a6a94d7f25e729746ab210e8e7854fb5890ba Signed-off-by: Lovett, Trevor --- docs/contributing.rst | 4 ++++ docs/installation.rst | 6 ++++++ 2 files changed, 10 insertions(+) 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 `__ * NOTE: The only variation is that the line-length can be 88 characters vs. 80 +* All code must be formatted using the `Black `__ + code formatter. VVP uses the `pre-commit library `__ + 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. diff --git a/docs/installation.rst b/docs/installation.rst index a20bbed..2e561fd 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -52,3 +52,9 @@ or its `GitHub mirror `__. 3. Install the required dependencies with the following command:: > python pip install -r requirements.txt + +4. If you plan to make code changes, then initialize the standard git + commit hooks by initializing pre-commit:: + + > pre-commit install + -- cgit 1.2.3-korg