Dieses Dokument definiert die Standards für Commit-Messages, die konkret in unserem Repositorium genutzt werden. Die Verwendung konsistenter Commit-Messages verbessert die Lesbarkeit der Git-Historie und erleichtert das Verständnis von Änderungen.
Für allgemeine Commit-Standards besuchen Sie bitte: conventionalcommits.org
Alle Commit-Messages folgen folgendem Format:
<typ>: <kurze beschreibung>
feat
Verwendung: Neue Features, Funktionen oder Verbesserungen
Beispiele:
feat: implement search functionality
feat: add support for dark mode
fix
Verwendung: Behebung von technischen Fehlern und Bugs
Beispiele:
fix: resolve overwritten files
fix: also commit CITATION.cff if changed
docs
Verwendung: Inhaltliche Änderungen sowie Änderungen an Dokumentation und Markdown-Dateien, einschließlich Tippfehlern
Beispiele:
docs: fix typo in README.md
docs: exchange cross-target link in 'epilog'
add
Verwendung: Hinzufügen neuer Dateien, Assets oder Ressourcen
Beispiele:
add: new logo image
add: orcid-image link as button
update
Verwendung: Kleine allgemeine Änderungen und Neuerungen, die nicht in andere Kategorien passen
Beispiele:
update: improve button styling
update: upload new logo image
Für die Benennung von Branches verwenden wir folgendes Format:
- Nur Kleinbuchstaben
- Englische Sprache
- Wörter werden mit Bindestrich (-) voneinander getrennt
- Prägnanter Titel, aus dem hervorgeht, worum es geht
Beispiel:
add-summative-assessment-module
- Verwendung des Imperativs (z.B. "add" statt "added")
- Verwendung von Kleinbuchstaben mit Außnahme von spezifischen Dateinamen (z.B. README.md)
- Formulierung kurzer und prägnanter Aussagen
- Verwendung von Englisch für Konsistenz
- Formate und Richtlinien der hier formulierten Standards gelten auch für
pull request