Skip to content

Commit d6a268c

Browse files
Merge pull request #240 from MichaelEischer/update-changelog-template
Update changelog template with changes from restic
2 parents 3130a4b + d890dba commit d6a268c

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

changelog/TEMPLATE

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1+
# The first line must start with Bugfix:, Enhancement: or Change:,
2+
# including the colon. Use present tense. Remove lines starting with '#'
3+
# from this template.
14
Bugfix: Fix behavior for foobar (in present tense)
25

6+
# Describe the problem in the past tense, the new behavior in the present
7+
# tense. Mention the affected commands, backends, operating systems, etc.
8+
# Focus on user-facing behavior, not the implementation.
9+
310
We've fixed the behavior for foobar, a long-standing annoyance for rest-server
411
users.
512

6-
The text in the paragraphs is written in past tense. The last section is a list
7-
of issue URLs, PR URLs and other URLs. The first issue ID (or the first PR ID,
8-
in case there aren't any issue links) is used as the primary ID.
13+
# The last section is a list of issue, PR and forum URLs.
14+
# The first issue ID determines the filename for the changelog entry:
15+
# changelog/unreleased/issue-1234. If there are no relevant issue links,
16+
# use the PR ID and call the file pull-55555.
917

10-
https://github.com/restic/restic/issues/1234
11-
https://github.com/restic/restic/pull/55555
12-
https://forum.restic/.net/foo/bar/baz
18+
https://github.com/restic/rest-server/issues/1234
19+
https://github.com/restic/rest-server/pull/55555
20+
https://forum.restic.net/foo/bar/baz

0 commit comments

Comments
 (0)