Erste Schritte
Lerne unsere Commit-Konvention
2 min read
•265 wordsWir mögen einen sauberen Projektverlauf. Unsere Commit-Konvention ist inspiriert von Conventional Commits, aber mit gitmoji angepasst, um es visuell ansprechender und lustiger zu machen.
Struktur
Die Commit-Nachricht sollte wie folgt strukturiert sein und in kleingeschriebener Form:
<gitmoji> <type> <description> [(#<issue number>)]
[optional body]
[optional footer(s)]
Beispiel
📝 update documentation contributors
- Add @jerembdn as a contributor
- Add @younesbessa as a contributor
Co-authored-by: Younes Bessa <[email protected]>
Meistens reicht eine einfache Einzeiler-Nachricht:
📝 update documentation contributors
Typen
Wir verwenden die folgenden Commit-Typen:
| Typ | Beschreibung |
|---|---|
add | Eine neue Funktion hinzufügen |
fix | Einen Fehler beheben |
improve | Etwas verbessern |
update | Etwas aktualisieren |
remove | Etwas entfernen |
refactor | Etwas umstrukturieren |
rename | Etwas umbenennen |
move | Eine Datei oder einen Ordner verschieben |
upgrade | Abhängigkeiten aktualisieren |
downgrade | Abhängigkeiten herabstufen |
Beschreibung
Schreibe Beschreibungen im Imperativ und kleingeschrieben:
# Gut
📝 update documentation contributors
# Schlecht
📝 updated documentation contributors
# Schlecht
📝 Update documentation contributors
Issue-Nummer
Verlinke Commits zu Issues, indem du die Issue-Nummer hinzufügst:
📝 update documentation contributors (#123)
Body
Verwende den Body für Kontext und Motivation:
📝 update documentation contributors
- Add @jerembdn as a contributor
- Add @younesbessa as a contributor
Co-authored-by: Younes Bessa <[email protected]>
Ein Commit, Ein Zweck
Jeder Commit sollte eine einzelne logische Änderung repräsentieren. Mische keine nicht zusammenhängenden Änderungen.
Last updated on 01/14/2026