Skip to content

Commit c118aa5

Browse files
author
Elijah
committed
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
1 parent 24e1158 commit c118aa5

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

CONTRIBUTING.rst

+3
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,6 @@ Make sure your code conforms to the coding style:
4242
isort --check-only --diff --recursive ./channels ./tests
4343
4444
Push to your fork and `submit a pull request <https://github.com/django/channels/compare/>`_.
45+
46+
Note:
47+
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]'``

docs/contributing.rst

+2
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ Note the ``[tests]`` section there; that tells ``pip`` that you want to install
8080
the ``tests`` extra, which will bring in testing dependencies like
8181
``pytest-django``.
8282

83+
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]'``.
84+
8385
Then, you can run the tests:
8486

8587
.. code-block:: sh

0 commit comments

Comments
 (0)