matrix-org / matrix-org/matrix-spec
Grammar for room IDs (SPEC-389)
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Room IDs (and Event IDs, prior to room v3) are opaque to the user (they should never be seen), but they do have some syntax within the protocol; this means that they can be more baroque than User IDs, but are not as freeform as some other IDs (https://github.com/matrix-org/matrix-spec/issues/174).
We should ensure their syntax is well-specified, and make sure we know which characters they can include.
(Imported from https://matrix.org/jira/browse/SPEC-389)
(Reported by @richvdh)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Room ID and Event ID syntax requirements described in this issue, then compare them with the related Matrix specification discussion in issue #174. Done means the permitted characters and grammar are explicitly specified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100