Skip to content

Commit e5f33b9

Browse files
authored
Clean up MSC_CHECKLIST.md (#4200)
Signed-off-by: Catalan Lover [email protected]
1 parent 27bc9a5 commit e5f33b9

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

MSC_CHECKLIST.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,42 @@ MSC authors, feel free to ask in a thread on your PR or in the
1111
[#matrix-spec:matrix.org](https://matrix.to/#/#matrix-spec:matrix.org) room for
1212
clarification of any of these points.
1313

14-
- [ ] Are [appropriate
15-
implementation(s)](https://spec.matrix.org/proposals/#implementing-a-proposal)
16-
specified in the MSC’s PR description?
14+
- [ ] Are [appropriate implementation(s)](https://spec.matrix.org/proposals/#implementing-a-proposal)
15+
specified in the MSC’s PR description?
1716
- [ ] Are all MSCs that this MSC depends on already accepted?
1817
- [ ] For each new endpoint that is introduced:
19-
- [ ] Have authentication requirements been specified?
20-
- [ ] Have rate-limiting requirements been specified?
21-
- [ ] Have guest access requirements been specified?
22-
- [ ] Are error responses specified?
23-
- [ ] Does each error case have a specified `errcode` (e.g. `M_FORBIDDEN`) and HTTP status code?
24-
- [ ] If a new `errcode` is introduced, is it clear that it is new?
18+
- [ ] Have authentication requirements been specified?
19+
- [ ] Have rate-limiting requirements been specified?
20+
- [ ] Have guest access requirements been specified?
21+
- [ ] Are error responses specified?
22+
- [ ] Does each error case have a specified `errcode` (e.g. `M_FORBIDDEN`) and HTTP status code?
23+
- [ ] If a new `errcode` is introduced, is it clear that it is new?
2524
- [ ] Will the MSC require a new room version, and if so, has that been made clear?
26-
- [ ] Is the reason for a new room version clearly stated? For example,
25+
- [ ] Is the reason for a new room version clearly stated? For example,
2726
modifying the set of redacted fields changes how event IDs are calculated,
2827
thus requiring a new room version.
2928
- [ ] Are backwards-compatibility concerns appropriately addressed?
3029
- [ ] Are the [endpoint conventions](https://spec.matrix.org/latest/appendices/#conventions-for-matrix-apis) honoured?
31-
- [ ] Do HTTP endpoints `use_underscores_like_this`?
32-
- [ ] Will the endpoint return unbounded data? If so, has pagination been considered?
33-
- [ ] If the endpoint utilises pagination, is it consistent with [the
34-
appendices](https://spec.matrix.org/v1.8/appendices/#pagination)?
30+
- [ ] Do HTTP endpoints `use_underscores_like_this`?
31+
- [ ] Will the endpoint return unbounded data? If so, has pagination been considered?
32+
- [ ] If the endpoint utilises pagination, is it consistent with
33+
[the appendices](https://spec.matrix.org/v1.8/appendices/#pagination)?
3534
- [ ] An introduction exists and clearly outlines the problem being solved.
36-
Ideally, the first paragraph should be understandable by a non-technical
37-
audience
35+
Ideally, the first paragraph should be understandable by a non-technical audience.
3836
- [ ] All outstanding threads are resolved
39-
- [ ] All feedback is incorporated into the proposal text itself, either as a fix or noted as an alternative
40-
- [ ] While the exact sections do not need to be present, the details implied by the proposal template are covered. Namely:
41-
- [ ] Introduction
42-
- [ ] Proposal text
43-
- [ ] Potential issues
44-
- [ ] Alternatives
45-
- [ ] Dependencies
37+
- [ ] 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:
40+
- [ ] Introduction
41+
- [ ] Proposal text
42+
- [ ] Potential issues
43+
- [ ] Alternatives
44+
- [ ] Dependencies
4645
- [ ] Stable identifiers are used throughout the proposal, except for the unstable prefix section
47-
- [ ] Unstable prefixes [consider](README.md#unstable-prefixes) the awkward accepted-but-not-merged state
48-
- [ ] Chosen unstable prefixes do not pollute any global namespace (use “org.matrix.mscXXXX”, not “org.matrix”).
46+
- [ ] Unstable prefixes [consider](README.md#unstable-prefixes) the awkward accepted-but-not-merged state
47+
- [ ] Chosen unstable prefixes do not pollute any global namespace (use “org.matrix.mscXXXX”, not “org.matrix”).
4948
- [ ] Changes have applicable [Sign Off](CONTRIBUTING.md#sign-off) from all authors/editors/contributors
50-
- [ ] 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/).
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/).

0 commit comments

Comments
 (0)