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

Clarify that changelog entries end with a full stop

Browse source
This commit is contained in:
Travis Ralston 2019-01-17 11:41:50 -07:00
parent fcc26d247e
commit 5f12419afb
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.rst
View file

@ -76,11 +76,11 @@ Adding to the changelog
Currently only changes to the client-server API need to end up in a changelog. The
other APIs are not yet stable and therefore do not have a changelog. Adding to the
changelog can only be done after you've opened your pull request, so be sure to do
that first.
that first.
The changelog is managed by Towncrier (https://github.com/hawkowl/towncrier) in the
form of "news fragments". The news fragments for the client-server API are stored
under ``changelogs/client_server/newsfragments``.
under ``changelogs/client_server/newsfragments``.
To create a changelog entry, create a file named in the format ``prNumber.type`` in
the ``newsfragments`` directory. The ``type`` can be one of the following:
@ -99,7 +99,7 @@ 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.
of the file. The summary must end in a full stop to be in line with the style guide.
Changes that do not change the spec, such as changes to the build script, formatting,
CSS, etc should not get a news fragment.