From 611594d1e7e05de25bc1c60cd8a54b352ba41d69 Mon Sep 17 00:00:00 2001 From: David Cain Date: Wed, 3 Aug 2022 08:41:05 -0700 Subject: [PATCH] Fix `pip install` command for contributors on zsh On `zsh` (a popular shell, and the default for macOS), install fails: $ pip install -U -e .[validation] zsh: no matches found: .[validation] Quote the arguments so that `bash` or `zsh` will succeed. --- CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ec6e92dd..9ee65570 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -36,7 +36,7 @@ You want to contribute some code? Great! Here are a few steps to get you started $ python -m venv venv $ source venv/bin/activate (venv) $ python -m pip install -U pip setuptools - (venv) $ pip install -U -e .[validation] + (venv) $ pip install -U -e '.[validation]' (venv) $ pip install -U -r requirements/dev.txt #. **Make your changes and check them against the test project** @@ -96,7 +96,7 @@ You want to contribute some code? Great! Here are a few steps to get you started #. **Your code must pass all the required CI jobs before it is merged** As of now, this consists of running on the supported Python, Django, DRF version matrix (see README), - and building the docs succesfully. + and building the docs successfully. ****************** Maintainer's notes