From 408062dd432e60e1ed09abf8e15532998c0435bf Mon Sep 17 00:00:00 2001 From: Bibo-Joshi Date: Wed, 29 Jan 2020 21:43:57 +0100 Subject: [PATCH] Add note on how to run test_official to contrib guide (#1740) --- .github/CONTRIBUTING.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 0e6b1e60e..40332fc3f 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -113,6 +113,14 @@ Here's how to make a one-off code change. $ pytest -v + To run ``test_official`` (particularly useful if you made API changes), run + + .. code-block:: + + $ export TEST_OFFICIAL=True + + prior to running the tests. + - To actually make the commit (this will trigger tests for yapf, lint and pep8 automatically): .. code-block:: bash