From 736169eef2af746ddc8baf9a18d43cf8f3974fba Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Thu, 1 Feb 2024 05:31:17 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Clarify=20need=20to=20only=20ref?= =?UTF-8?q?=20PR=20@=20change=20note=20name?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGES/README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGES/README.rst b/CHANGES/README.rst index 41099212e..196cc71e5 100644 --- a/CHANGES/README.rst +++ b/CHANGES/README.rst @@ -36,6 +36,9 @@ telling the readers **what changed** in a specific version of the library *since the previous version*. You should also use *reStructuredText* syntax for highlighting code (inline or block), linking parts of the docs or external sites. +However, you do not need to reference the issue or PR numbers here +as *towncrier* will automatically add a reference to all of the +affected issues when rendering the news file. Finally, name your file following the convention that Towncrier understands: it should start with the number of an issue or a