matrix-org / matrix-org/matrix-spec
What determines if a room is publicly listed? (SPEC-189)
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
We currently have a `publicRooms` API, but we haven't decided what should be listed here or how its managed.
The current (bad) behaviour is that when a room is create on the HS with a `visibility: true` option on, then it gets added to the list. A room is only included in the list if the HS has an alias for it.
(Imported from https://matrix.org/jira/browse/SPEC-189)
(Reported by @erikjohnston)
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
Start with the publicRooms API behavior described here, including visibility:true and the requirement for a homeserver alias. Define and document the listing rules and lifecycle for public rooms; done means the specification gives an unambiguous, implementable answer.
Written by the indexing model from the issue text.
Assessment
- Domain
- backend-api-design, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100