matrix-org / matrix-org/matrix.org

"How to contribute to the Spec" explainer

Open
#2,077 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

potential guide
Dominant language
JavaScript
Stars
616
Forks
463
Avg merge
2d 3h
Merged PRs (30d)
19

Description

We need a “how to contribute to the spec for the person who is browsing the website on their phone between two meetings” explainer somewhere on m.org, that is essentially a simplified version of https://spec.matrix.org/proposals/#process and that points to it.

It's important to highlight that the SCT needs to be notified when a MSC feels ready for review

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 linked spec process page and reviewing the existing matrix.org site structure to find the appropriate location for the explainer. Done means a concise, mobile-friendly contribution guide is published on m.org, links to the full process, and explains that the SCT must be notified when an MSC is ready for review.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.