matrix-org / matrix-org/matrix-spec

Consider making error codes spec-independent (put them in the appendix)

Open
#363 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Many are reusable outside of the spec they are defined in, such as `M_BAD_JSON` and `M_FORBIDDEN`. Some are very tightly scoped, like `M_THREEPID_DENIED`, but may still be of use to define outside of one particular area.

Should build off of the suggestions in https://github.com/matrix-org/matrix-doc/issues/603.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the suggestions in matrix-org/matrix-doc#603 and the current error-code definitions in the Matrix specification. Determine which codes can be made spec-independent and how they should be organized in an appendix; the work is done when the proposed organization and affected definitions are consistently updated.

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
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.