matrix-org / matrix-org/matrix-spec

Comunicate next steps of an MSC better

Open
#1,669 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Process
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Contributors do not always know what they need to do to advance an MSC, and the MSC process document can be daunting. Perhaps we need a way to indicate, on the MSC, what the next steps are. Or some other way to guide contributors.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the MSC process document and reviewing how existing MSCs communicate contributor guidance. Determine a concrete way to show the next steps without requiring contributors to navigate the full process document, then document the agreed approach and verify it is understandable to contributors.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.