octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-12-26 20:30:19 +00:00
Code Issues Releases Wiki Activity

Changelogs should omit problem if it duplicates the new behavior

Browse Source 
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.
This commit is contained in:
Michael Eischer 2024-09-14 20:54:27 +02:00
parent efec1a5e96
commit 7680f48258
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog/TEMPLATE
View File

@ -5,6 +5,8 @@ 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.
# 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. # Focus on user-facing behavior, not the implementation.
# Use "Restic now ..." instead of "We have changed ...". # Use "Restic now ..." instead of "We have changed ...".