Skip to content

Commit

Permalink
πŸ“ Clarify need to only ref PR @ change note name
Browse files Browse the repository at this point in the history
  • Loading branch information
webknjaz committed Feb 1, 2024
1 parent 887846f commit 736169e
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGES/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 736169e

Please sign in to comment.