Keep a Changelog — Das Format erklaert

Was ist Keep a Changelog?

Keep a Changelog ist ein Satz von Konventionen zum Schreiben von Changelogs. Es wurde geschaffen, um ein haeufiges Problem zu loesen: Die meisten Changelogs sind entweder automatisch generierte Commit-Dumps oder gar nicht vorhanden. Das Format priorisiert Menschen vor Maschinen.

Leitprinzipien

1. Changelogs sind fuer Menschen, nicht fuer Maschinen.
2. Es sollte einen Eintrag fuer jede einzelne Version geben.
3. Gleiche Arten von Aenderungen sollten gruppiert werden.
4. Versionen sollten verlinkbar sein.
5. Die neueste Version kommt zuerst.
6. Release-Daten werden fuer jede Version angezeigt.

Aenderungstypen

• Added — Neue Features
• Changed — Aenderungen an bestehender Funktionalitaet
• Deprecated — Features, die bald entfernt werden
• Removed — Entfernte Features
• Fixed — Fehlerbehebungen
• Security — Sicherheits-Fixes

Vollstaendiges Beispiel

# Changelog

All notable changes to this project will be documented in this file.

## [Unreleased]

### Added
- New webhook endpoint for real-time notifications

## [1.1.0] - 2026-03-15

### Added
- Dark mode support
- Email notifications for subscribers

### Fixed
- Widget loading issue on mobile Safari

## [1.0.0] - 2026-02-01

### Added
- Initial release with REST API
- Embeddable changelog widget
- Project management dashboard

Haeufige Anti-Patterns

• Git-Commits als Changelog verwenden — das will niemand lesen.
• Fehlende Release-Daten — Nutzer muessen wissen, wann Aenderungen stattfanden.
• Auf einen Diff verlinken statt eine Zusammenfassung zu schreiben — zwingt Nutzer, rohen Code zu interpretieren.
• Keine Kategorien — macht es unmoeglich, nach relevanten Aenderungen zu suchen.

Keep a Changelog + Deplyd

Deplyd folgt der Keep-a-Changelog-Philosophie und fuegt moderne Distribution hinzu: ein 1,8 KB einbettbares Widget, REST API fuer CI/CD-Integration und E-Mail-Benachrichtigungen, damit deine Nutzer kein Update verpassen.