summary refs log tree commit diff
path: root/changelog.d
diff options
context:
space:
mode:
authorForest Johnson <forest.n.johnson@gmail.com>2022-01-25 14:09:56 +0000
committerGitHub <noreply@github.com>2022-01-25 14:09:56 +0000
commit4210143f535d0bb0df5e3836bb3f6b0857631b46 (patch)
tree359cd0e9cac3c755ebd551d6d4ace25f2f536d6e /changelog.d
parentMerge branch 'master' into develop (diff)
downloadsynapse-4210143f535d0bb0df5e3836bb3f6b0857631b46.tar.xz
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.
Diffstat (limited to 'changelog.d')
-rw-r--r--changelog.d/11821.doc1
1 files changed, 1 insertions, 0 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.