paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 13:33:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Mention TODO/compatibility comments for events migrations.

Browse Source
This commit is contained in:
Tim Abbott
2021-05-26 15:21:48 -07:00
parent f236a0d10d
commit 0294ce76b4
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/subsystems/events-system.md
View File

@@ -434,7 +434,10 @@ to make sure we handle backwards-compatibility properly.
commit. We attempt to contain that sort of logic in the `from_dict`
function (which is used for changing event queue formats) and
`client_capabilities` conditionals (E.g. in
`process_deletion_event`).
`process_deletion_event`). Compatibility code not related to a
`client_capabilities` entry should be marked with a
`# TODO/compatibility: ...` comment noting when it can be safely deleted;
we grep for these comments entries during major releases.
* Schema changes are a sensitive operation, and like with database
schema changes, it's critical to do thoughtful manual testing.
E.g. run the mobile app against your test server and verify it