diff options
| -rw-r--r-- | changelog.d/11821.doc | 1 | ||||
| -rw-r--r-- | docs/development/contributing_guide.md | 3 |
2 files changed, 3 insertions, 1 deletions
diff --git a/changelog.d/11821.doc b/changelog.d/11821.doc new file mode 100644 index 0000000000..a16a6ef956 --- /dev/null +++ b/changelog.d/11821.doc @@ -0,0 +1 @@ +Add missing steps to the contribution submission process in the documentation. Contributed by @sequentialread. diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index c142981693..8448685952 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -55,6 +55,7 @@ setup a *virtualenv*, as follows: cd path/where/you/have/cloned/the/repository python3 -m venv ./env source ./env/bin/activate +pip install wheel pip install -e ".[all,dev]" pip install tox ``` @@ -116,7 +117,7 @@ The linters look at your code and do two things: - ensure that your code follows the coding style adopted by the project; - catch a number of errors in your code. -They're pretty fast, don't hesitate! +The linter takes no time at all to run as soon as you've [downloaded the dependencies into your python virtual environment](#4-install-the-dependencies). ```sh source ./env/bin/activate |