From 7971fc68fd06f2923e36b85470ca274b4ccc56e5 Mon Sep 17 00:00:00 2001 From: Elijah Date: Fri, 2 Jun 2023 13:37:50 +1000 Subject: [PATCH] Added installation notes to the contribution docs * Running the command prompts on Zsh might produce an error * Suggestion to use quotations around [tests] to overcome this --- CONTRIBUTING.rst | 3 +++ docs/contributing.rst | 2 ++ 2 files changed, 5 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 19faea4bc..a2fda810e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -42,3 +42,6 @@ Make sure your code conforms to the coding style: isort --check-only --diff --recursive ./channels ./tests Push to your fork and `submit a pull request `_. + +Note: +For those using zsh, you might encounter the error ``zsh: no matches found: .[tests]``. In this case, try wrapping quotations around the ``[tests]]`` section like so ``'.[tests]'`` \ No newline at end of file diff --git a/docs/contributing.rst b/docs/contributing.rst index 5f61bc4b4..f635c9e73 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -80,6 +80,8 @@ Note the ``[tests]`` section there; that tells ``pip`` that you want to install the ``tests`` extra, which will bring in testing dependencies like ``pytest-django``. +For those using zsh, you might encounter encounter the error ``zsh: no matches found: .[tests]``. In this case, try wrapping quotations around the ``[tests]`` section like so ``'.[tests]'``. + Then, you can run the tests: .. code-block:: sh