Skip to content

Commit

Permalink
Document the removal changelog category (#1907)
Browse files Browse the repository at this point in the history
* Document the removal changelog category

Signed-off-by: Johannes Marbach <[email protected]>

* Add changelog

---------

Signed-off-by: Johannes Marbach <[email protected]>
  • Loading branch information
Johennes committed Jul 16, 2024
1 parent cbe8092 commit c8eb7f5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1907.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document the `removal` changelog category.

0 comments on commit c8eb7f5

Please sign in to comment.