forked from TrueCloudLab/restic
7680f48258
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.
25 lines
1.2 KiB
Text
25 lines
1.2 KiB
Text
# The first line must start with Bugfix:, Enhancement: or Change:,
|
|
# 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.
|
|
# 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 ...".
|
|
|
|
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.
|
|
|
|
# The last section is a list of issue, PR and forum URLs.
|
|
# The first issue ID determines the filename for the changelog entry:
|
|
# changelog/unreleased/issue-1234. If there are no relevant issue links,
|
|
# use the PR ID and call the file pull-55555.
|
|
|
|
https://github.com/restic/restic/issues/1234
|
|
https://github.com/restic/restic/pull/55555
|
|
https://forum.restic.net/foo/bar/baz
|