Add an "MSC Checklist" document and link to it from various places #4061
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anoadragon453
commented
Oct 18, 2023
MTRNord
reviewed
Oct 18, 2023
wrjlewis
reviewed
Oct 18, 2023
clokep
reviewed
Oct 18, 2023
clokep
reviewed
Oct 18, 2023
clokep
reviewed
Oct 18, 2023
MSC_CHECKLIST.md
Outdated
| - [ ] Does each error case have a specified `errcode` (e.g. `M_FORBIDDEN`) and HTTP status code? | ||
| - [ ] If a new `errcode` is introduced, is it clear that it is new? | ||
| - [ ] Will the MSC require a new room version, and if so, has that been made clear? | ||
| - [ ] 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. |
There was a problem hiding this comment.
I think @turt2live and I had talked about something with "Be really sure everyone knows exactly how new redaction rules are handled."
clokep
reviewed
Oct 18, 2023
clokep
reviewed
Oct 18, 2023
turt2live
approved these changes
Oct 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an "MSC Checklist" to the repo. This is essentially just a list of checks to perform on an MSC before considering it accepted (or checking a box on a
@mscbot fcp mergecomment).The document is linked from various places so MSC authors are aware of it, hopefully leading to self-checks being performed.