matrix-org / matrix-org/matrix-spec
Should kicks contain a key for bridges to pass information to aware clients.
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
My use case is the classic err_needreggednick kick by the IRC bridge which leaves users confused as to what to do next.
We could provide detailed instructions in the response but then we are relying on your client to be similar to Riot when it could be something like a terminal client, or another bridge!
I'd like to propose that "reason" continues to be freeform text for client's to show as a fallback or user generated reason, but to also include another key (errcode?) for putting a code in (possibly something like org.matrix.irc.needreggednick) ?
I'm also listing bans in here although they are not used yet by the bridge.
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 issue's proposal for a structured kick error alongside the freeform reason, including the suggested errcode and bridge ban use case. Determine the protocol design and client-facing behavior needed, then document the agreed format and scope in the Matrix specification.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100