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

Specify news fragments must be done in RST.

Browse source
This commit is contained in:
Andrew Morgan 2019-02-25 09:47:19 +00:00
parent 23b2420520
commit 4049ca9208
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.rst
View file

@ -98,8 +98,10 @@ the ``newsfragments`` directory. The ``type`` can be one of the following:
* ``deprecation`` - Used when deprecating something
All news fragments must have a brief summary explaining the change in the contents
of the file. The summary must end in a full stop to be in line with the style guide.
All news fragments must have a brief summary explaining the change in the
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,
CSS, etc should not get a news fragment.