From 7680f482588354ec343c26bed79cfacd7b8af74f Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sat, 14 Sep 2024 20:54:27 +0200 Subject: [PATCH] Changelogs should omit problem if it duplicates the new behavior When adding a new feature, the problem description often just says that feature Y was missing, followed by saying that feature Y is now supported. This duplication just makes the changelog entries unnecessarily verbose. --- changelog/TEMPLATE | 2 ++ 1 file changed, 2 insertions(+) diff --git a/changelog/TEMPLATE b/changelog/TEMPLATE index 9304359b3..7d6065e04 100644 --- a/changelog/TEMPLATE +++ b/changelog/TEMPLATE @@ -5,6 +5,8 @@ Enhancement: Allow custom bar in the foo command # Describe the problem in the past tense, the new behavior in the present # tense. Mention the affected commands, backends, operating systems, etc. +# If the problem description just says that a feature was missing, then +# only explain the new behavior. # Focus on user-facing behavior, not the implementation. # Use "Restic now ..." instead of "We have changed ...".