From b5005e64f7e85dc48941d34ac65e9377dd044073 Mon Sep 17 00:00:00 2001 From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Date: Wed, 16 Nov 2022 13:44:55 +0000 Subject: [PATCH] Document that non-spec changes should get an 'internal' changelog entry (#1342) --- CONTRIBUTING.rst | 11 ++++++----- changelogs/internal/newsfragments/1342.clarification | 1 + 2 files changed, 7 insertions(+), 5 deletions(-) create mode 100644 changelogs/internal/newsfragments/1342.clarification diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 86ed1595..2aeefd7e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -76,8 +76,12 @@ All API specifications require a changelog entry. Adding to the changelog can on be done after you've opened your pull request, so be sure to do that first. The changelog is managed by `Towncrier `_ in the -form of "news fragments". The news fragments for the client-server API are stored -under ``changelogs/client_server/newsfragments``. +form of "news fragments". Depending on which API you changed, an entry should be added to +each relevant API's ``newsfragments`` directory. A directory exists for each API under +``changelogs/``. For instance, news fragments for the client-server API are stored +under ``changelogs/client_server/newsfragments``. Any changes to the repository that do +not affect the spec content itself, such as changes to the build script, formatting, CSS, +etc. should be documented under ``changelogs/internal/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,9 +103,6 @@ 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 formatting must be done using Markdown. -Changes that do not change the spec, such as changes to the build script, formatting, -CSS, etc should not get a news fragment. - Sign off -------- diff --git a/changelogs/internal/newsfragments/1342.clarification b/changelogs/internal/newsfragments/1342.clarification new file mode 100644 index 00000000..4586000d --- /dev/null +++ b/changelogs/internal/newsfragments/1342.clarification @@ -0,0 +1 @@ +Update CONTRIBUTING.md to mention that non-content changes to this repo should have an "internal" changelog entry. \ No newline at end of file