chore: Add note for zsh and swap pytest for tox

django · Nov 23, 2023 · ba3306d · ba3306d
1 parent 2db92cc
commit ba3306d
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -26,13 +26,20 @@ Make sure the tests pass:
 .. code-block:: sh
 
     python -m pip install -e .[tests]
-    pytest
+    tox
+
+.. note::
+   If you're using ``zsh`` for your shell, the above command will fail with a
+   ``zsh: no matches found: .[tests]`` error.
+   To fix this use ``noglob``::
+
+       noglob python -m pip install -e .[tests]
 
 Make your change. Add tests for your change. Make the tests pass:
 
 .. code-block:: sh
 
-    pytest
+    tox
 
 Make sure your code conforms to the coding style: