From c8eb7f552678b7522ad5f65fb0b3651b68e3f82f Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Wed, 17 Jul 2024 00:15:44 +0200 Subject: [PATCH] Document the removal changelog category (#1907) * Document the removal changelog category Signed-off-by: Johannes Marbach * Add changelog --------- Signed-off-by: Johannes Marbach --- CONTRIBUTING.rst | 2 ++ changelogs/internal/newsfragments/1907.clarification | 1 + 2 files changed, 3 insertions(+) create mode 100644 changelogs/internal/newsfragments/1907.clarification diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a12287695..def7ced25 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -99,6 +99,8 @@ the ``newsfragments`` directory. The ``type`` can be one of the following: * ``deprecation`` - Used when deprecating something. +* ``removal`` - Used when removing something that was unused or previously deprecated. + 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. diff --git a/changelogs/internal/newsfragments/1907.clarification b/changelogs/internal/newsfragments/1907.clarification new file mode 100644 index 000000000..9185f533d --- /dev/null +++ b/changelogs/internal/newsfragments/1907.clarification @@ -0,0 +1 @@ +Document the `removal` changelog category.