Kann man beim Changelog etwas falsch machen?
Einen Diff von Commit-Logs ausgeben
Commit-Logs in einem Changelog sind eine schlechte Idee: Sie beinhalten lauter überflüssige Dinge, wie Merge-Commit, Commits mit schlechten Bezeichnungen, Änderungen an der Dokumentation, etc.
Der Sinn eines Commits ist die Entwicklung des Source Code zu dokumentieren. Manche Projekte haben saubere Commits, andere nicht.
Der Sinn eines Changelog-Eintrags ist die Dokumentation der merkbaren Unterschiede, die meist über mehrere Commits hinweg entstanden sind, dem Endnutzer klar und deutlich zu kommunizieren.
Features ohne Deprecation-Warnung entfernen
Wenn der Endnutzer auf eine neue Version upgradet, sollte ihm unmissverständlich klar gemacht werden, wenn etwas kaputt gehen wird. Es sollte immer möglich sein, zu einer Version zu upgraden, die die zu entfernenden Features auflistet, um so in seinem Source Code auf diese Features zu verzichten. Anschließend sollte man auf eine Version upgraden können, in der die Features entfernt wurden.
Auch wenn du sonst nichts geändert hast, liste trotzdem alle veralteten und entfernten Features, sowie jede funktionsgefährdende Änderung in deinem Changelog auf.