From 87745a352ffbfe5bda5e99388f89ae17f6e63c91 Mon Sep 17 00:00:00 2001 From: "Thomas S. Binns" Date: Sun, 10 May 2026 18:39:33 +0100 Subject: [PATCH 1/2] Update changelog descriptions --- doc/development/contributing.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/development/contributing.rst b/doc/development/contributing.rst index cea1fd9e746..d149e4368ca 100644 --- a/doc/development/contributing.rst +++ b/doc/development/contributing.rst @@ -587,12 +587,14 @@ deprecation period when the stated release is being prepared: parameter, and (if found) update them to use the new function / parameter. +.. _`changelog-guide`: + Describe your changes in the changelog -------------------------------------- -Include in your changeset a brief description of the change in the -:ref:`changelog ` using towncrier_ format, which aggregates small, -properly-named ``.rst`` files to create a changelog. This can be +Include in your changeset a brief description of the changes, which will appear in the +:ref:`changelog `, using towncrier_ format. This aggregates small, +properly named ``.rst`` files to create a changelog. This can be skipped for very minor changes like correcting typos in the documentation. There are six separate sections for changes, based on change type. @@ -1024,8 +1026,9 @@ down the road. Here are the guidelines: you are specifically asked by a maintainer to PR into another branch (e.g., for backports or maintenance bugfixes to the current stable version). -- Don't forget to include in your PR a brief description of the change in the - :ref:`changelog ` (:file:`doc/whats_new.rst`). +- Don't forget to include in your PR a brief description of the change in a + changelog entry (see :ref:`the changelog section ` above + for instructions). - Our community uses the following commit tags and conventions: From 356f4ddba485053b63bfad7e5772c7f8e4d75189 Mon Sep 17 00:00:00 2001 From: "Thomas S. Binns" Date: Sun, 10 May 2026 18:46:56 +0100 Subject: [PATCH 2/2] [skip actions][skip azp]