archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1909 from matrix-org/anoa/contrib_rst

Browse Source 
Specify news fragments must be done in RST
pull/977/head
Andrew Morgan 6 years ago committed by GitHub
parent 23b2420520 4049ca9208
commit 1c731630f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File

6
CONTRIBUTING.rst
Unescape Escape View File

@ -98,8 +98,10 @@ the ``newsfragments`` directory. The ``type`` can be one of the following:
* ``deprecation`` - Used when deprecating something * ``deprecation`` - Used when deprecating something
All news fragments must have a brief summary explaining the change in the contents All news fragments must have a brief summary explaining the change in the
of the file. The summary must end in a full stop to be in line with the style guide. contents of the file. The summary must end in a full stop to be in line with
the style guide and and formatting must be done using `Restructured Text
<http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_.
Changes that do not change the spec, such as changes to the build script, formatting, Changes that do not change the spec, such as changes to the build script, formatting,
CSS, etc should not get a news fragment. CSS, etc should not get a news fragment.

Write Preview
Loading…
Cancel
Save