You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MSC_CHECKLIST.md
+8-17Lines changed: 8 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,7 @@ MSC authors, feel free to ask in a thread on your PR or in the
11
11
[#matrix-spec:matrix.org](https://matrix.to/#/#matrix-spec:matrix.org) room for
12
12
clarification of any of these points.
13
13
14
-
-[ ] Are [appropriate implementation(s)](https://spec.matrix.org/proposals/#implementing-a-proposal)
15
-
specified in the MSC’s PR description?
14
+
-[ ] Are [appropriate implementation(s)](https://spec.matrix.org/proposals/#implementing-a-proposal) specified in the MSC’s PR description?
16
15
-[ ] Are all MSCs that this MSC depends on already accepted?
17
16
-[ ] For each new endpoint that is introduced:
18
17
-[ ] Have authentication requirements been specified?
@@ -22,31 +21,23 @@ clarification of any of these points.
22
21
-[ ] Does each error case have a specified `errcode` (e.g. `M_FORBIDDEN`) and HTTP status code?
23
22
-[ ] If a new `errcode` is introduced, is it clear that it is new?
24
23
-[ ] Will the MSC require a new room version, and if so, has that been made clear?
25
-
-[ ] Is the reason for a new room version clearly stated? For example,
26
-
modifying the set of redacted fields changes how event IDs are calculated,
27
-
thus requiring a new room version.
24
+
-[ ] Is the reason for a new room version clearly stated? For example, modifying the set of redacted fields changes how event IDs are calculated, thus requiring a new room version.
28
25
-[ ] Are backwards-compatibility concerns appropriately addressed?
29
26
-[ ] Are the [endpoint conventions](https://spec.matrix.org/latest/appendices/#conventions-for-matrix-apis) honoured?
30
27
-[ ] Do HTTP endpoints `use_underscores_like_this`?
31
28
-[ ] Will the endpoint return unbounded data? If so, has pagination been considered?
32
-
-[ ] If the endpoint utilises pagination, is it consistent with
-[ ] An introduction exists and clearly outlines the problem being solved.
35
-
Ideally, the first paragraph should be understandable by a non-technical audience.
29
+
-[ ] If the endpoint utilises pagination, is it consistent with [the appendices](https://spec.matrix.org/latest/appendices/#pagination)?
30
+
-[ ] An introduction exists and clearly outlines the problem being solved. Ideally, the first paragraph should be understandable by a non-technical audience.
36
31
-[ ] All outstanding threads are resolved
37
32
-[ ] All feedback is incorporated into the proposal text itself, either as a fix or noted as an alternative
38
-
-[ ] While the exact sections do not need to be present,
39
-
the details implied by the proposal template are covered. Namely:
33
+
-[ ] While the exact sections do not need to be present, the details implied by the proposal template are covered. Namely:
40
34
-[ ] Introduction
41
35
-[ ] Proposal text
42
36
-[ ] Potential issues
43
37
-[ ] Alternatives
44
38
-[ ] Dependencies
45
39
-[ ] Stable identifiers are used throughout the proposal, except for the unstable prefix section
46
-
-[ ] Unstable prefixes [consider](/README.md#unstable-prefixes) the awkward accepted-but-not-merged state
40
+
-[ ] Unstable prefixes [consider](https://github.com/matrix-org/matrix-spec-proposals/blob/main/README.md#unstable-prefixes) the awkward accepted-but-not-merged state
47
41
-[ ] Chosen unstable prefixes do not pollute any global namespace (use “org.matrix.mscXXXX”, not “org.matrix”).
48
-
-[ ] Changes have applicable [Sign Off](/CONTRIBUTING.md#sign-off) from all authors/editors/contributors
49
-
-[ ] There is a dedicated "Security Considerations" section which detail
50
-
any possible attacks/vulnerabilities this proposal may introduce, even if this is "None.".
51
-
See [RFC3552](https://datatracker.ietf.org/doc/html/rfc3552) for things to think about,
52
-
but in particular pay attention to the [OWASP Top Ten](https://owasp.org/www-project-top-ten/).
42
+
-[ ] Changes have applicable [Sign Off](https://github.com/matrix-org/matrix-spec-proposals/blob/main/CONTRIBUTING.md#sign-off) from all authors/editors/contributors
43
+
-[ ] There is a dedicated "Security Considerations" section which detail any possible attacks/vulnerabilities this proposal may introduce, even if this is "None.". See [RFC3552](https://datatracker.ietf.org/doc/html/rfc3552) for things to think about, but in particular pay attention to the [OWASP Top Ten](https://owasp.org/www-project-top-ten/).
0 commit comments