Implementieren eines Änderungsprotokolls
Das Konzept eines Änderungsprotokolls ist einfach genug: Es handelt sich um eine Datei mit einer Liste von Änderungen, die an einem Projekt vorgenommen wurden, in der Regel in der Datumsreihenfolge. Die typische Aufschlüsselung besteht darin, eine Liste der Versionen zu trennen und dann in jeder Version folgendes anzuzeigen:
- Hinzugefügte Features
- Geänderte/verbesserte Features
- Gelöschte Funktionen
Einige Teams veröffentlichen Änderungsprotokollen als Blogbeiträge; andere erstellen eine CHANGELOG.md Datei in einem GitHub-Repository.
Automatisiertes Änderungsprotokolltool
Während Änderungsprotokollen erstellt und manuell verwaltet werden können, sollten Sie ein automatisiertes Changelog-Erstellungstool in Betracht ziehen. Zumindest als Ausgangspunkt.
Verwenden von systemeigenen GitHub-Befehlen
Der Befehl "Git-Protokoll" kann zum automatischen Erstellen von Inhalten hilfreich sein. Beispiel: Erstellen eines neuen Abschnitts pro Version:
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Git-Änderungsprotokoll
Ein Standardtool ist gitchangelog. Dieses Tool basiert auf Python.
GitHub-Änderungsprotokoll-Generator
Ein weiteres Standardtool wird github-changelog-generator bezeichnet.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Dieses Tool basiert auf Gem.
Sollten Sie automatisch generierte protokollbasierte Daten verwenden?
Die Präferenz besteht immer darin, zu vermeiden, Protokolleinträge in ein Änderungsprotokoll einzufügen. Protokolle sind "laut", sodass es einfach ist, ein Unordnung zu generieren, das nicht hilfreich ist.