matrix-org / matrix-org/matrix-spec

Spec is inconsistent with usage of PDU versus event

Open
#572 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This can cause confusion about what to sign and when - maybe we just remove 'pdu' from the terminology as much as possible?

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

Start by reviewing the specification passages that use “PDU” and “event,” especially where signing and timing are discussed. Done means the terminology and its usage are consistent enough that readers can tell what to sign and when; the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.