From de0a3c3a2a0eced7ba19ef078a71f2b1a667d123 Mon Sep 17 00:00:00 2001 From: chagai95 <31655082+chagai95@users.noreply.github.com> Date: Thu, 12 Nov 2020 08:47:49 +0100 Subject: [PATCH 1/3] Update README.rst Minor corrections and advice... Should help beginners. --- README.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 59d5a4389bc8..ae4b20cb556c 100644 --- a/README.rst +++ b/README.rst @@ -259,10 +259,12 @@ to install using pip and a virtualenv:: python3 -m venv ./env source ./env/bin/activate pip install -e ".[all,test]" - + This will run a process of downloading and installing all the needed dependencies into a virtual env. +Some of the dependencies might have to be installed manually, if you run into errors just install the dependency that is mentioned in the error manually. + Once this is done, you may wish to run Synapse's unit tests, to check that everything is installed as it should be:: @@ -270,9 +272,11 @@ check that everything is installed as it should be:: This should end with a 'PASSED' result:: - Ran 1266 tests in 643.930s + Ran 1332 tests in 716.064s + + PASSED (skips=15, successes=1317) - PASSED (skips=15, successes=1251) +(The amount of tests may change in the future...) Running the Integration Tests ============================= From af7172eb0c702ebd898355f6f0999571d263c3fa Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Fri, 13 Nov 2020 11:30:50 +0000 Subject: [PATCH 2/3] Some minor wording changes --- README.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index ae4b20cb556c..d724cf97da18 100644 --- a/README.rst +++ b/README.rst @@ -259,24 +259,24 @@ to install using pip and a virtualenv:: python3 -m venv ./env source ./env/bin/activate pip install -e ".[all,test]" - + This will run a process of downloading and installing all the needed -dependencies into a virtual env. +dependencies into a virtual env. If any dependencies fail to install, +try installing the failing modules individually:: -Some of the dependencies might have to be installed manually, if you run into errors just install the dependency that is mentioned in the error manually. + pip install -e "module-name" -Once this is done, you may wish to run Synapse's unit tests, to -check that everything is installed as it should be:: +Once this is done, you may wish to run Synapse's unit tests to +check that everything is installed correctly:: python -m twisted.trial tests -This should end with a 'PASSED' result:: - - Ran 1332 tests in 716.064s +This should end with a 'PASSED' result (note that exact numbers will +differ):: - PASSED (skips=15, successes=1317) + Ran 1337 tests in 716.064s -(The amount of tests may change in the future...) + PASSED (skips=15, successes=1322) Running the Integration Tests ============================= From c173b570fb061d0ffb3f6116b3849b4550045b00 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Fri, 13 Nov 2020 11:32:42 +0000 Subject: [PATCH 3/3] Add changelog --- changelog.d/8746.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/8746.doc diff --git a/changelog.d/8746.doc b/changelog.d/8746.doc new file mode 100644 index 000000000000..6baf58ba7ae8 --- /dev/null +++ b/changelog.d/8746.doc @@ -0,0 +1 @@ +Add some helpful hints to the README for new Synapse developers. Contributed by @chagai95. \ No newline at end of file