Skip to content

Commit 82c2d68

Browse files
authored
Update describing changes in contributing guide (#13895)
1 parent 9438956 commit 82c2d68

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

doc/development/contributing.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -587,12 +587,14 @@ deprecation period when the stated release is being prepared:
587587
parameter, and (if found) update them to use the new function / parameter.
588588

589589

590+
.. _`changelog-guide`:
591+
590592
Describe your changes in the changelog
591593
--------------------------------------
592594

593-
Include in your changeset a brief description of the change in the
594-
:ref:`changelog <whats_new>` using towncrier_ format, which aggregates small,
595-
properly-named ``.rst`` files to create a changelog. This can be
595+
Include in your changeset a brief description of the changes, which will appear in the
596+
:ref:`changelog <whats_new>`, using towncrier_ format. This aggregates small,
597+
properly named ``.rst`` files to create a changelog. This can be
596598
skipped for very minor changes like correcting typos in the documentation.
597599

598600
There are six separate sections for changes, based on change type.
@@ -1024,8 +1026,9 @@ down the road. Here are the guidelines:
10241026
you are specifically asked by a maintainer to PR into another branch (e.g.,
10251027
for backports or maintenance bugfixes to the current stable version).
10261028

1027-
- Don't forget to include in your PR a brief description of the change in the
1028-
:ref:`changelog <whats_new>` (:file:`doc/whats_new.rst`).
1029+
- Don't forget to include in your PR a brief description of the change in a
1030+
changelog entry (see :ref:`the changelog section <changelog-guide>` above
1031+
for instructions).
10291032

10301033
- Our community uses the following commit tags and conventions:
10311034

0 commit comments

Comments
 (0)