wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

formatting

Browse source
This commit is contained in:
Richard van der Hoff 2017-10-13 02:17:40 +01:00
parent d3a4ad06c7
commit 30b5005266
1 changed files with 54 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.rst
View file

@ -14,9 +14,10 @@ in `GitHub <https://github.com/matrix-org/matrix-doc/issues>`_.
The following labels are used to help categorize issues:
`spec-omission <https://github.com/matrix-org/matrix-doc/labels/spec-omission>`_
Things which have been implemented but not currently specified. These may
range from entire API endpoints, to particular options or return
parameters.
--------------------------------------------------------------------------------
Things which have been implemented but not currently specified. These may range
from entire API endpoints, to particular options or return parameters.
Issues with this label will have been implemented in `Synapse
<https://github.com/matrix-org/synapse>`_. Normally there will be a design
@ -29,6 +30,8 @@ The following labels are used to help categorize issues:
<https://github.com/matrix-org/matrix-doc/issues/904>`_
`clarification <https://github.com/matrix-org/matrix-doc/labels/clarification>`_
--------------------------------------------------------------------------------
An area where the spec could do with being more explicit.
Examples:
@ -40,6 +43,8 @@ The following labels are used to help categorize issues:
<https://github.com/matrix-org/matrix-doc/issues/686>`_
`bug <https://github.com/matrix-org/matrix-doc/labels/bug>`_
------------------------------------------------------------
Something which is in the spec, but is wrong.
Note: this is *not* for things that are badly designed or don't work well
@ -55,6 +60,8 @@ The following labels are used to help categorize issues:
<https://github.com/matrix-org/matrix-doc/issues/695>`_
`improvement <https://github.com/matrix-org/matrix-doc/labels/improvement>`_
----------------------------------------------------------------------------
A suggestion for a relaatively simple improvement to the protocol.
Examples:
@ -65,6 +72,8 @@ The following labels are used to help categorize issues:
<https://github.com/matrix-org/matrix-doc/issues/612>`_
`feature <https://github.com/matrix-org/matrix-doc/labels/feature>`_
--------------------------------------------------------------------
A suggestion for a significant extension to the matrix protocol which
needs considerable consideration before implementation.
@ -75,6 +84,8 @@ The following labels are used to help categorize issues:
<https://github.com/matrix-org/matrix-doc/issues/682>`_
`projects <https://github.com/matrix-org/matrix-doc/labels/projects>`_
----------------------------------------------------------------------
A project which needs adding to the 'Try Matrix Now' page.
Examples: