matrix-org / matrix-org/matrix-spec
What are the set(s) of core-events that are covered by the protocol.
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:
Working out the scope of protocol use cases.
For example, what events are required to send a E2EE message between two parties. Similarly for receive.
Or a different one, what is the set of events required to securely CRUD a room with N participants, etc. As well as issue #2124.
Issue
What is wrong?
There is no succinct list/statement of what are the set of core-events in the protocol. But the idea exists with some prominence ("... Matrix specification defines a number of event types which are considered core to the protocol."). It would also be useful in some other contexts (#129, #2124).
How can we improve?
Have a single page listing the set of core-events. Defining the core-event set is aided by a definition of scope. Say, for example, "Events required to pass a E2EE message between two parties.", or some variation on that .
Related:
Issue #129: This is at a higher level than the use case described there. Naturally, the statement/list of the core-events (hyperlinked) would likely have helped that author:
It's also difficult to use the specification as a reference for events because they are distributed across several sections in the document.
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 protocol event sections referenced by the issue, along with related issues #129 and #2124, to establish the scope of “core-events.” Done means agreeing on a use-case scope and adding a single page that lists the corresponding event set.
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
- 35/100