matrix-org / matrix-org/matrix-spec
ABNF variables are inconsistent
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**:
* https://spec.matrix.org/v1.7/appendices/#server-name
* https://spec.matrix.org/v1.7/appendices/#user-identifiers
* https://spec.matrix.org/v1.7/appendices/#historical-user-ids
* https://spec.matrix.org/v1.7/appendices/#matrix-uri-scheme
**Issue**
We use a curious mix of `-`, `_`, and no delimiter when creating element names in our [ABNF](https://datatracker.ietf.org/doc/html/rfc5234) grammar definitions.
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
Start by comparing the ABNF element names in the linked server-name, user-identifiers, historical-user-ids, and Matrix URI scheme sections. Identify the delimiter convention intended for grammar definitions, then update the affected definitions so naming is consistent across those sections. Done means the linked ABNF definitions use one consistent convention and the specification remains valid.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100