From 7d1535fe7943207f5966ad55fe8738d175ebe2f6 Mon Sep 17 00:00:00 2001 From: ItsDrike Date: Fri, 30 Dec 2022 00:57:01 +0100 Subject: [PATCH] Explain how to handle PRs making multiple distinct changes of same category --- changes/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/changes/README.md b/changes/README.md index c4db2265..4186fe4c 100644 --- a/changes/README.md +++ b/changes/README.md @@ -32,6 +32,14 @@ the file with your `$EDITOR`. If necessary, multiple fragment files can be created per pull-request, with different change types, if the PR covers multiple areas (for example a PR that both introduces a feature, and changes the documentation). +Additionally, if a single PR is addressing multiple unrelated topics in the same category, and needs to make multiple +distinct changelog entries, you can do so by adding an optional counter value to the fragment file name, which needs to +be an integer, for example: `25.internal.1.md` and `25.internal.2.md`. This counter value will not be shown in the +final changelog and is merely here for separation of the individual fragments. That said, if you end up making multiple +distinct changelog fragments like this is a good sign that your PR is probably too big, and you should split it up into +multiple PRs. Making huge PRs that address several unrelated topics at once are generally a bad practice, and should be +avoided. + To preview the latest changelog, run `towncrier build --draft --version [version number]`. (For version number, you can pretty much enter anything as this is just for a draft version. For true builds, this would be the next version number, so for example, if the current version is 1.0.2, next one will be one either 1.0.3, or 1.1.0, or 2.0.0. But for drafts,