Skip to content

Commit

Permalink
📝 Mention avoiding PR numbers @ change notes
Browse files Browse the repository at this point in the history
  • Loading branch information
webknjaz committed Nov 14, 2024
1 parent 6c529da commit d33add5
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.
If you wish to sign your change, feel free to add ``-- by
:user:`github-username``` at the end (replace ``github-username``
with your own!).
Expand Down

0 comments on commit d33add5

Please sign in to comment.