matrix-org / matrix-org/matrix-spec
Add necessity to check MSCs for clear requirement levels to checklist
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
I suggest adding a point to the https://github.com/matrix-org/matrix-spec-proposals/blob/main/MSC_CHECKLIST.md along the lines of
- [ ] requirement levels for the proposed change and all its aspects are clearly stated
This should improve clarity and avoid situations such as https://github.com/matrix-org/matrix-spec/pull/2410#discussion_r3586691433
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
Open MSC_CHECKLIST.md and review the existing checklist wording and section structure. Add a checklist item requiring clear requirement levels for the proposed change and all its aspects, with wording consistent with nearby entries. Done means the new item appears in the checklist and the Markdown renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 90/100