matrix-org / matrix-org/matrix-js-sdk
Event snapshotting is confusing
- Dominant language
- TypeScript
- Stars
- 2.2k
- Forks
- 704
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 40
Description
https://github.com/matrix-org/matrix-js-sdk/pull/1738 introduces snapshots, but between the docs trying to explain that not everything is cloned and the fact that not everything is cloned, it's confusing. Part of this is due to technical overhead of trying to maintain rich models, so we may want to consider less dynamic models.
Contributor guide
Research direction
Start by reading PR #1738 and the snapshot documentation it introduced, then identify which parts of event models are and are not cloned. The issue does not name files or tests; work is not ready to call done until the intended snapshot behavior and model approach are agreed and the documentation explains that behavior clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100