matrix-org / matrix-org/matrix-spec

Email invite flow is under-specified

Open
#1,359 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

According to @turt2live,

worth noting that there's two flows an email invite can take, and only one of those flows is documented in the spec. The other is completely missing.

I don't know how the flows differ, or what causes one flow rather than another to be used.

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 with the email-invite flow documented in the Matrix specification and read the discussion in matrix-org/sydent#338, especially the linked comment. Investigate what the two flows are and what determines which one is used. The work is done when both flows and their distinguishing conditions are documented in the specification.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.