From 886ef8464d73288cd2b7984e08d20757338ac908 Mon Sep 17 00:00:00 2001 From: Chris Lenk Date: Thu, 29 Aug 2019 16:14:40 -0400 Subject: [PATCH] Add contributing note about isort --- docs/contributing.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 9aa2f0e..20cab3a 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -109,3 +109,11 @@ then look at the resulting report in ``htmlcov/index.html``. All commits pushed to the ``master`` branch or submitted as a pull request are tested with `Travis-CI `_ automatically. + +Adding a dependency +------------------- + +One of the pre-commit hooks we use in our develoment environment enforces a +consistent ordering to imports. If you need to add a new library as a dependency +please add it to the `known_third_party` section of `.isort.cfg` to make sure +the import is sorted correctly.