matrix-org / matrix-org/matrix-spec

Should we be descriptive or prescriptive about how room upgrades work?

Open
#1,906 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Currently [the spec](https://spec.matrix.org/v1.11/client-server-api/#server-behaviour-17) leaves pretty much everything as an implementation detail. Servers appear to all implement the same set of behaviours though, and there are proposals to make the spec more prescriptive:

* https://github.com/matrix-org/matrix-spec-proposals/pull/4168
* https://github.com/matrix-org/matrix-spec-proposals/pull/4167

This leaves an open question: do we think the spec should be *more* prescriptive generally for room upgrades, or do we prefer to leave this as an implementation detail? This issue tracks that conversation as no specific MSC fits well imo.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the room-upgrade server behaviour section in the linked Matrix specification and the discussions in MSC PRs 4168 and 4167. The issue asks whether room-upgrade behavior should be specified more prescriptively or left to implementations; it records an open discussion rather than a defined change, so there is no implementation-level completion criterion yet.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.