Ein Changelog schreiben, aus deinen Commits

Fülle ein kurzes Formular aus und erhalte eine aufgeräumte README.md mit Installationsschritten, Nutzung, Konfiguration und Lizenz oder eine CHANGELOG.md im Format „Keep a Changelog“. Sieh das Ergebnis beim Tippen. Alles wird in deinem Browser geschrieben, und nichts, was du tippst, wird hochgeladen. Kostenlos.

So erstellst du eine README, Schritt für Schritt

1. Wähle oben README.md.
2. Gib unter „Über das Projekt“ den Projektnamen, eine Zusammenfassung in einem Satz, eine Beschreibung sowie Funktionen und Voraussetzungen ein, jeweils eine pro Zeile.
3. Wähle unter „Installation und Nutzung“ einen Paketmanager wie npm, pip oder Cargo, gib die Repository-URL an und beschreibe die Nutzung. Wähle die Sprache für die Nutzung, damit der Code richtig formatiert wird.
4. Füge bei Bedarf Einstellungen und Entwicklungsbefehle hinzu.
5. Wähle eine Lizenz und den Urheberrechtsinhaber und schalte bei Bedarf Inhaltsverzeichnis, Lizenz-Badge oder einen Abschnitt zum Mitwirken ein.
6. Klick auf „Markdown kopieren“ oder „README.md herunterladen“.

Was eine gute README ausmacht

Sag in einer Zeile, was das Projekt tut, und zeige dann, wie man es installiert, mit dem kleinsten funktionierenden Beispiel. Leser entscheiden in Sekunden, ob ein Projekt passt, daher folgen Funktionen und Voraussetzungen, dann Einstellungen, Entwicklungsbefehle, Hinweise zum Mitwirken und die Lizenz. Abschnitte, die du leer lässt, werden weggelassen.

Changelogs, die Menschen lesen können

Das Changelog folgt „Keep a Changelog“: das neueste Release zuerst, jeweils mit Datum und seinen Änderungen, gruppiert als „Hinzugefügt“, „Geändert“, „Veraltet“, „Entfernt“, „Behoben“ und „Sicherheit“. Behalte oben einen Abschnitt „Unreleased“ für Änderungen, die noch nicht ausgeliefert wurden. Mit einer Repository-Adresse verlinkt jede Version auf den Vergleich mit der vorherigen. Du kannst ein älteres Release von Hand hinzufügen oder Einträge aus Commit-Nachrichten erstellen.

Tipps

• Setze einen funktionierenden Installationsbefehl und ein kurzes Anwendungsbeispiel weit nach oben.
• Nenne die Lizenz deutlich, damit andere wissen, wie sie deinen Code nutzen dürfen.
• Beschreibe, was das Projekt für die Leserschaft tut, nicht wie du es gebaut hast.
• Aktualisiere das Changelog mit jedem Release, nicht erst am Ende.

Um Geheimnisse und Build-Dateien aus einem Repository herauszuhalten, nutze den gitignore-Generator und den Generator für .env-Beispiele.

Fragen

Kann ich mit meiner Commit-Historie anfangen?

Ja. Füge die Ausgabe von git log --oneline unter „Aus Commit-Nachrichten“ ein. Commits mit feat:, fix:, perf: und Ähnlichem werden den richtigen Gruppen zugeordnet, und mit Ausrufezeichen markierte Breaking Changes werden gekennzeichnet. Überarbeite danach die Formulierungen: Commit-Nachrichten sind für Entwickler geschrieben, Changelogs für Nutzer.

Wird der Lizenztext eingefügt?

Es fügt einen Abschnitt License hinzu, der die Lizenz nennt und auf eine LICENSE-Datei verweist. Leg den vollständigen Lizenztext in diese Datei. Du findest ihn auf der offiziellen Seite der Lizenz.

Wo landen die Dateien?

Herunterladen speichert README.md oder CHANGELOG.md auf deinem Gerät. Leg die Datei in die oberste Ebene deines Repositorys, dann zeigen Code-Hoster sie auf der Projektseite an.

Welche Lizenzen kann ich wählen?

MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, ISC, MPL 2.0, Unlicense oder All rights reserved – oder du lässt den Abschnitt weg.