From 7952a72e71057143a77bc9ccbadcd70f1b9a7ba7 Mon Sep 17 00:00:00 2001 From: Forest Johnson Date: Mon, 24 Jan 2022 21:46:37 -0600 Subject: [PATCH 1/6] Docs: add missing PR submission process how-tos The documentation says that in order to submit a pull request you have to run the linter and links to [Run the linters](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#run-the-linters). IMO "Run the linters" should explain that development dependencies are a pre-requisite. I also included `pip install wheel` which I had to run inside my virtual environment on ubuntu before I `pip install -e ".[all,dev]"` would succeed. --- docs/development/contributing_guide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index c14298169351..59a272c7ff87 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -53,8 +53,9 @@ setup a *virtualenv*, as follows: ```sh cd path/where/you/have/cloned/the/repository -python3 -m venv ./env +python3 -m venv ./envx 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 long as you've [downloaded the dependencies into your python virtual environment](#4-install-the-dependencies). ```sh source ./env/bin/activate From 12cffd0523361c0b057afa205d6d1484f5f9ebcd Mon Sep 17 00:00:00 2001 From: Forest Johnson Date: Mon, 24 Jan 2022 21:51:09 -0600 Subject: [PATCH 2/6] Create 11821.doc --- changelog.d/11821.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/11821.doc diff --git a/changelog.d/11821.doc b/changelog.d/11821.doc new file mode 100644 index 000000000000..a1956db1af45 --- /dev/null +++ b/changelog.d/11821.doc @@ -0,0 +1 @@ +Add missing steps to the contribution submission process in the documentation. From 00fe70740d330910a4048946f58d34fc0b440daa Mon Sep 17 00:00:00 2001 From: Forest Johnson Date: Mon, 24 Jan 2022 21:52:55 -0600 Subject: [PATCH 3/6] Update 11821.doc --- changelog.d/11821.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/11821.doc b/changelog.d/11821.doc index a1956db1af45..7c9e32018407 100644 --- a/changelog.d/11821.doc +++ b/changelog.d/11821.doc @@ -1 +1 @@ -Add missing steps to the contribution submission process in the documentation. +Add missing steps to the contribution submission process in the documentation. Contributed by @sequentialread From aeec8e1b00d60e415c07447b2e7f20a045077767 Mon Sep 17 00:00:00 2001 From: Forest Johnson Date: Mon, 24 Jan 2022 21:53:37 -0600 Subject: [PATCH 4/6] oops typo --- docs/development/contributing_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 59a272c7ff87..a6dfdb589623 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -53,7 +53,7 @@ setup a *virtualenv*, as follows: ```sh cd path/where/you/have/cloned/the/repository -python3 -m venv ./envx +python3 -m venv ./env source ./env/bin/activate pip install wheel pip install -e ".[all,dev]" From 54c42aa2aac311b15a01e5c4fc76fc3f23429d4a Mon Sep 17 00:00:00 2001 From: Forest Johnson Date: Mon, 24 Jan 2022 21:54:35 -0600 Subject: [PATCH 5/6] wording edit --- docs/development/contributing_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index a6dfdb589623..8448685952dc 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -117,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. -The linter takes no time at all to run as long as you've [downloaded the dependencies into your python virtual environment](#4-install-the-dependencies). +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 From e1ac97488259ab2f498c678f038f017dcb0cb9af Mon Sep 17 00:00:00 2001 From: Forest Johnson Date: Mon, 24 Jan 2022 21:59:14 -0600 Subject: [PATCH 6/6] perieodo --- changelog.d/11821.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/11821.doc b/changelog.d/11821.doc index 7c9e32018407..a16a6ef956e2 100644 --- a/changelog.d/11821.doc +++ b/changelog.d/11821.doc @@ -1 +1 @@ -Add missing steps to the contribution submission process in the documentation. Contributed by @sequentialread +Add missing steps to the contribution submission process in the documentation. Contributed by @sequentialread.