2
2
mirror of https://github.com/octoleo/restic.git synced 2024-11-22 04:45:15 +00:00

Extend style guide in changelog template

This commit is contained in:
Michael Eischer 2023-07-29 12:55:56 +02:00
parent be03c1a457
commit 9a0ec05145

View File

@ -1,16 +1,17 @@
# The first line must start with Bugfix:, Enhancement: or Change:, # The first line must start with Bugfix:, Enhancement: or Change:,
# including the colon. Use present tense. Remove lines starting with '#' # including the colon. Use present tense and the imperative mood. Remove
# from this template. # lines starting with '#' from this template.
Enhancement: Allow custom bar in the foo command Enhancement: Allow custom bar in the foo command
# Describe the problem in the past tense, the new behavior in the present # Describe the problem in the past tense, the new behavior in the present
# tense. Mention the affected commands, backends, operating systems, etc. # tense. Mention the affected commands, backends, operating systems, etc.
# Focus on user-facing behavior, not the implementation. # 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 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 item in the `baz` backend. It now permits selecting the bar with `--bar`
the environment variable RESTIC_BAR. The system-wide bar is still the or the environment variable `RESTIC_BAR`. The system-wide bar is still
default. the default.
# The last section is a list of issue, PR and forum URLs. # The last section is a list of issue, PR and forum URLs.
# The first issue ID determines the filename for the changelog entry: # The first issue ID determines the filename for the changelog entry: