You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Small change in the Matrix class: deprecated methods have been removed and the constructor is now public. Also the fun `workerFactory()` has been renamed to `getWorkerFactory()`
Copy file name to clipboardExpand all lines: docs/add_threePids.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -37,9 +37,9 @@ Wording: "We've sent you an email to verify your address. Please follow the inst
37
37
}
38
38
```
39
39
40
-
## User receive an e-mail
40
+
## User receives an e-mail
41
41
42
-
> [homeserver.org] Validate your email
42
+
> `homeserver.org` Validate your email
43
43
>
44
44
> A request to add an email address to your Matrix account has been received. If this was you, please click the link below to confirm adding this email:
Copy file name to clipboardExpand all lines: docs/integration_tests.md
+16-1
Original file line number
Diff line number
Diff line change
@@ -43,14 +43,17 @@ virtualenv -p python3 env
43
43
source env/bin/activate
44
44
pip install -e .
45
45
demo/start.sh --no-rate-limit
46
+
46
47
```
47
48
48
-
Alternatively, to install the latest Synapse release package (and not a cloned branch) you can run the following instead of `pip install -e .`:
49
+
Alternatively, to install the latest Synapse release package (and not a cloned branch) you can run the following instead of `git clone` and `pip install -e .`:
49
50
50
51
```bash
51
52
pip install matrix-synapse
52
53
```
53
54
55
+
On your first run, you will want to stop the demo and edit the config to correct the `public_baseurl` to http://10.0.2.2:8080 and restart the server.
56
+
54
57
You should now have 3 running federated Synapse instances 🎉, at http://127.0.0.1:8080/, http://127.0.0.1:8081/ and http://127.0.0.1:8082/, which should display a "It Works! Synapse is running" message.
55
58
56
59
## Run the test
@@ -87,6 +90,18 @@ You'll need python3 to be able to run synapse
87
90
88
91
Try on the Emulator browser to open "http://10.0.2.2:8080". You should see the "Synapse is running" message.
89
92
93
+
### Tests partially run but some fail with "Unable to contact localhost:8080"
94
+
95
+
This is because the `public_baseurl` of synapse is not consistent with the endpoint that the tests are connecting to.
96
+
97
+
Ensure you have the following configuration in `demo/etc/8080.config`.
98
+
99
+
```
100
+
public_baseurl: http://10.0.2.2:8080/
101
+
```
102
+
103
+
After changing this you will need to restart synapse using `demo/stop.sh` and `demo/start.sh` to load the new configuration.
Copy file name to clipboardExpand all lines: docs/pull_request.md
+15-2
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,19 @@ In any case, it is better to explicitly declare in the description why the PR is
30
30
31
31
Also, draft PR should not stay indefinitely in this state. It may be removed if it is the case and the submitter does not update it after a few days.
32
32
33
+
##### Base branch
34
+
35
+
The `develop` branch is generally the base branch for every PRs.
36
+
37
+
Exceptions can occur:
38
+
39
+
- if a feature implementation is split into multiple PRs. We can have a chain of PRs in this case. PR can be merged one by one on develop, and GitHub change the target branch to `develop` for the next PR automatically.
40
+
- we want to merge a PR from the community, but there is still work to do, and the PR is not updated by the submitter. First, we can kindly ask the submitter if they will update their PR, by commenting it. If there is no answer after a few days (including a week-end), we can create a new branch, push it, and change the target branch of the PR to this new branch. The PR can then be merged, and we can add more commits to fix the issues. After that a new PR can be created with `develop` as a target branch.
41
+
42
+
**Important notice 1:** Releases are created from the `develop` branch. So `develop` branch should always contain a "releasable" source code. So when a feature is being implemented with several PRs, it has to be disabled by default (using a feature flag for instance), until the feature is fully implemented. A last PR to enable the feature can then be created.
43
+
44
+
**Important notice 2:** Database migration: some developers and some people from the community are using the nightly build from `develop`. Multiple database migrations should be properly handled for them. This is OK to have multiple migrations between 2 releases, this is not OK to add steps to the pending database migration on `develop`. So for instance `develop` users will migrate from version 11 to version 12, then 13, then 14, and `main` users will do all those steps after they get the app upgrade.
45
+
33
46
##### PR Review Assignment
34
47
35
48
We use automatic assignment for PR reviews. A PR is automatically routed by GitHub to 2 team members using the round robin algorithm. The process is the following:
@@ -103,7 +116,7 @@ Review such PR is the same recipe than for PR from Dependabot
103
116
##### Sync analytics plan
104
117
105
118
This tools imports any update in the analytics plan. See instruction in the PR itself to handle it.
106
-
More info can be found in the file [analytics.md]
119
+
More info can be found in the file [analytics.md](./analytics.md)
107
120
108
121
## Reviewing PR
109
122
@@ -234,4 +247,4 @@ Also "Resolve conversation" should probably be hit by the creator of the convers
234
247
235
248
PR submitter is responsible of the incoming change. PR reviewers who approved the PR take a part of responsibility on the code which will land to develop, and then be used by our users, and the user of our forks.
236
249
237
-
That said, bug may still be merged on `develop`, this is still acceptable of course. In this case, please make sure an issue is created and correctly labelled. Ideally, such issues should be fixed before the next release candidate, i.e. with a higher priority. But as we release the application every 10 working days, it can be hard to fix every bugs. That's why PR should be fully tested and reviewed before being merge and we should never comment code review remark with "will be handled later", or similar comments.
250
+
That said, bug may still be merged on `develop`, this is still acceptable of course. In this case, please make sure an issue is created and correctly labelled. Ideally, such issues should be fixed before the next release candidate, i.e. with a higher priority. But as we release the application every 10 working days, it can be hard to fix every bugs. That's why PR should be fully tested and reviewed before being merge and we should never comment code review remark with "will be handled later", or similar comments.
0 commit comments