From 9a0ec0514519bd093f599f14b328e51c7cfc3d26 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sat, 29 Jul 2023 12:55:56 +0200 Subject: [PATCH] Extend style guide in changelog template --- changelog/TEMPLATE | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/changelog/TEMPLATE b/changelog/TEMPLATE index d512a2dc3..9304359b3 100644 --- a/changelog/TEMPLATE +++ b/changelog/TEMPLATE @@ -1,16 +1,17 @@ # The first line must start with Bugfix:, Enhancement: or Change:, -# including the colon. Use present tense. Remove lines starting with '#' -# from this template. +# including the colon. Use present tense and the imperative mood. Remove +# lines starting with '#' from this template. 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. # Focus on user-facing behavior, not the implementation. +# Use "Restic now ..." instead of "We have changed ...". Restic foo always used the system-wide bar when deciding how to frob an -item in the baz backend. It now permits selecting the bar with --bar or -the environment variable RESTIC_BAR. The system-wide bar is still the -default. +item in the `baz` backend. It now permits selecting the bar with `--bar` +or the environment variable `RESTIC_BAR`. The system-wide bar is still +the default. # The last section is a list of issue, PR and forum URLs. # The first issue ID determines the filename for the changelog entry: