From 5f12419afb108fab117840dfbed517165ef69049 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 17 Jan 2019 11:41:50 -0700 Subject: [PATCH] Clarify that changelog entries end with a full stop --- CONTRIBUTING.rst | 6 +++--- changelogs/client_server/newsfragments/1744.clarification | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c592cf02b..0666c5797 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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. diff --git a/changelogs/client_server/newsfragments/1744.clarification b/changelogs/client_server/newsfragments/1744.clarification index 6ed000674..dc1039200 100644 --- a/changelogs/client_server/newsfragments/1744.clarification +++ b/changelogs/client_server/newsfragments/1744.clarification @@ -1 +1 @@ -Add missing status_msg to m.presence schema +Add missing status_msg to m.presence schema.