From c2aad152efbcb75583f77d0abd572fab91735b9a Mon Sep 17 00:00:00 2001 From: derekpierre Date: Tue, 3 Nov 2020 14:49:57 -0500 Subject: [PATCH] Additional clarification about optional use of issue newsfragment files. --- newsfragments/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/newsfragments/README.md b/newsfragments/README.md index 7e4a87aee..76adf133a 100644 --- a/newsfragments/README.md +++ b/newsfragments/README.md @@ -5,8 +5,8 @@ release notes. This should be a description of aspects of the change commit message and PR description, which are a description of the change as relevant to people working on the code itself.) -The PR number should be used for the newsfragment file. Each file should be -named `..rst`, where `` is one of: +The pull request (PR) number should be used for the newsfragment file. Each file +should be named `..rst`, where `` is one of: * `feature` * `bugfix` @@ -15,6 +15,11 @@ named `..rst`, where `` is one of: For example: `123.feature.rst`, `456.bugfix.rst` +Along with the required PR newsfragment file (enforced by a GitHub Action), +additional newsfragment files for issues linked to the PR can optionally be +included by following the same naming convention above, and +using `` instead of ``. + Note that the `towncrier` tool will automatically reflow your text, so don't try to do any fancy formatting. Run `towncrier --draft` to get a preview of what the release notes entry