matrix-org / matrix-org/gomatrixserverlib

Meta: Specification lies/omissions/ambiguity

Open
#182 18 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted T-Other
Dominant language
Go
Stars
67
Forks
60
PR merge metrics
No merged PRs in 30d

Description

This issue tracks all issues we've found in the spec where the spec is:
- Wrong.
- Ambiguous.
- Not phrased as well as it could be.

If people are feeling particularly inclined, please PR on https://github.com/matrix-org/matrix-doc/pulls these issues and xref them here so we know it's done. Thanks!

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

Review the specification issues tracked here and the matrix-org/matrix-doc pull requests linked in the issue. Select a specific wrong, ambiguous, or poorly phrased item, verify the intended wording in the specification, and submit a PR that resolves it while cross-referencing this issue.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.