Changelog Guidelines
Zu jeder Software wird in der Systemdokumentation ein Changelog gepflegt. Jede Version wird in diesen Changelog aufgenommen.
Folgende Angaben sind möglich:
Added
für neue Features.Breaking
für alle Änderungen die Auswirkungen auf andere Codebestandteile haben (API-Changes)Changed
für Änderungen an der bestehenden Funktionalität.Deprecated
für Features, die in zukünftigen Versionen entfernt werden.Removed
für Deprecated-Features, die in dieser Version entfernt wurden.Fixed
für alle Bug-Fixes.Security
um Benutzer im Fall von geschlossenen Sicherheitslücken zu einer Aktualisierung aufzufordern.
Beispiel in Markdown:
# Changelog
## 3.0.0
* [Added] Szenarien können kopiert werden
* [Added] Gruppen können gelöscht werden
* [Added] Preise haben ein Ablaufdatum und können deaktiviert werden
* [Added] Artikel in Szenarien können mit einem Klick auf den alten Preis zurückgesetzt werden
* [Fixed] Collection Items werden gelöscht, sobald das Elternmodell gelöscht wird
* [Fixed] Datum wird nun auch entsprechend der Locale Einstellungen formatiert
* [Breaking] Propaganistas\LaravelIntl entfernt, da diese Abhängigkeit veraltet ist
* Propaganistas\LaravelIntl\Facades\Number -> App\Number
* Propaganistas\LaravelIntl\Facades\Currency -> App\Currency
* [Breaking] Scenario Erklärungen sind nun detailierter und in Scenario Pricing sichtbar
* In App\Domain\HasExplanation erwartet explanation nun ein Widget[]
* [Breaking] Customer config.php wird nicht mehr verwendet
* Gruppen konfigurierbar über CustomerProvider $groups Attribut.
* Models konfigurierbar über CustomerProvider $models Attribut.
* Scenario Calculation über Scenario Confiuration mit DefinesCalculation interface.
* [Breaking] Projektionen der Scenario Items werden nun mit Scenario Item ID gespeichert anstelle der Item ID
* [Breaking] Projektionen werden nun anstelle der Linse über Model Settings Objekten mit dem Interface DefinesProjection konfiguriert