matrix-org / matrix-org/matrix-spec
Unclear what a membership event means in the case of changing global profile info
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Link to problem area:
https://spec.matrix.org/v1.13/client-server-api/#events-on-change-of-profile-information
Issue
Noticed that some homeservers don't clear the reason field of a membership when updating one's global display name.
After some discussion, some homeserver implementation maintainers and I agreed that the spec is ambiguous on what to do with other fields in the membership events.
Should this be a new event? Should servers automatically clear some fields (reason, is_direct, join_authorised_by_users_server, etc.)? How does this work with custom profile fields (ie. room level overrides for custom profile keys)?
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 linked Matrix Client-Server API section on events when profile information changes, then review the discussion about membership fields and custom profile fields. Done means the specification explicitly defines whether the membership event is new and how fields such as reason, is_direct, join_authorised_by_users_server, and room-level custom profile overrides are handled.
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
- Needs clarification
- Newbie friendliness
- 25/100