Merge pull request #240 from MichaelEischer/update-changelog-template

Update changelog template with changes from restic
This commit is contained in:
Michael Eischer 2023-06-17 22:15:39 +02:00 committed by GitHub
commit d6a268ca01
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,12 +1,20 @@
# The first line must start with Bugfix:, Enhancement: or Change:,
# including the colon. Use present tense. Remove lines starting with '#'
# from this template.
Bugfix: Fix behavior for foobar (in present tense)
# 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.
We've fixed the behavior for foobar, a long-standing annoyance for rest-server
users.
The text in the paragraphs is written in past tense. The last section is a list
of issue URLs, PR URLs and other URLs. The first issue ID (or the first PR ID,
in case there aren't any issue links) is used as the primary ID.
# 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
https://github.com/restic/rest-server/issues/1234
https://github.com/restic/rest-server/pull/55555
https://forum.restic.net/foo/bar/baz