From e1e4e93ba2d570070058aaec64d69ef3123f7303 Mon Sep 17 00:00:00 2001
From: "Lovett, Trevor" <trevor.lovett@att.com>
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 <trevor.lovett@att.com>
---
 docs/contributing.rst | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'docs/contributing.rst')

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.
 
-- 
cgit 1.2.3-korg