Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 4210143

Browse files
Docs: add missing PR submission process how-tos (#11821)
* 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.
1 parent 6911604 commit 4210143

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

changelog.d/11821.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add missing steps to the contribution submission process in the documentation. Contributed by @sequentialread.

docs/development/contributing_guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ setup a *virtualenv*, as follows:
5555
cd path/where/you/have/cloned/the/repository
5656
python3 -m venv ./env
5757
source ./env/bin/activate
58+
pip install wheel
5859
pip install -e ".[all,dev]"
5960
pip install tox
6061
```
@@ -116,7 +117,7 @@ The linters look at your code and do two things:
116117
- ensure that your code follows the coding style adopted by the project;
117118
- catch a number of errors in your code.
118119

119-
They're pretty fast, don't hesitate!
120+
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).
120121

121122
```sh
122123
source ./env/bin/activate

0 commit comments

Comments
 (0)