Release Notes schreiben
Diese Seite ist für Designer, die den Text eines GitHub-Releases schreiben. Nutzer lesen Release Notes, um zu entscheiden, ob sie aktualisieren und was sie danach tun.
Die Teile
- Eine Überschrift, die sagt, worum es im Release geht.
- Was sich für den Nutzer geändert hat: ein Aufzählungspunkt pro Änderung, mit seinem Präfix (
Added:,Updated:,Fixed:...). - Was nach dem Update zu tun ist: Caches leeren, Einstellungen ergänzen, Upgrade-Skripte ausführen. Lassen Sie es nur weg, wenn nichts nötig ist, und schreiben Sie dann „Nach dem Update ist nichts zu tun.“
- Kompatibilität: die Versionen von Exponential und PHP, mit denen getestet wurde, falls sie sich geändert haben.
- Danksagungen: wer gemeldet oder beigetragen hat, mit öffentlichem Namen und mit Einwilligung.
- Eine Korrektur, wenn das Release ein früheres repariert: was an welcher Version falsch war.
Ein echtes Beispiel
Die Notes von cjw_themes_jumper v0.1.6 beginnen so:
## Starter design without inline code
The pages of the starter design now work under a Content Security Policy without `'unsafe-inline'`.
- The page script of every page (...) is `javascript/cjw_jumper_page.js`, loaded last in the packed head script ...
- The speech bubble's close link and the icon that opens it again are `href="#"` links with `data-cjw-bubble`
(no `javascript:` URLs) ...Eine Überschrift mit dem Nutzen, dann die Einzelheiten, die ein Template-Autor braucht.
Schritt für Schritt
- Kopieren Sie die Einträge des Releases aus
CHANGELOG.md. - Fügen Sie die Überschrift und den Abschnitt „nach dem Update“ hinzu.
- Lesen Sie es als Nutzer, der die letzten drei Releases übersprungen hat: Ist etwas unklar?
- Entfernen Sie alles Private: interne Pfade, Hostnamen, Kundennamen, Zugangsdaten.
- Speichern Sie es als Notes-Datei für
gh release create(GitHub-Releases).
Verwandte Seiten
- Changelog-Einträge
- Fallstudien und Content-Marketing
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.