Erste Schritte
Lerne unsere Commit-Konvention
Wir mögen eine saubere Projektgeschichte. Unser Commit-Standard ist inspiriert von Conventional Commits, aber angepasst mit gitmoji, um es visueller und unterhaltsamer zu machen.
Struktur
Die Commit-Nachricht sollte wie folgt strukturiert sein und in Kleinschreibung:
<gitmoji> <type> <description> [(#<issue number>)]
[optionale body]
[optionale 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 ein einfacher Einzeiler:
📝 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 |
initial | Erster Commit eines Repositories |
release | Veröffentlichung / Versions-Tag |
Der erste Commit eines Repositories verwendet initial, und ein Versions-Tag verwendet release:
🎉 initial commit
🔖 release @onruntime/translations v0.3.0
Beschreibung
Der <type> ist das Verb des Subjekts, und die Beschreibung vervollständigt es. Zusammen ergeben sie einen Satz:
# Gut
📝 update documentation contributors
Öffne die Beschreibung also nicht mit einem zweiten Verb. Der Typ ist bereits eins, und das Subjekt stapelt am Ende zwei Sätze, was ein fix:-Präfix zur Folge hat. Lass das Verb weg und behalte das, worauf es sich bezogen hat:
# Schlecht
💄 improve scale down the gem on its card
🐛 fix stop the footer from wrapping
# Gut
💄 improve the gem size on its card
🐛 fix the footer wrapping
Schreibe es im Imperativ und in Kleinschreibung:
# Schlecht
📝 updated documentation contributors
# Schlecht
📝 Update documentation contributors
Ein Verb, das ein Substantiv ist
Manche Wörter sind beides, und das, was du meinst, ist das Substantiv: ✨ add open graph image ist okay. Wenn es als Verb gelesen wird, macht ein Artikel es wieder zu einer Substantivphrase: ✨ add a show more button.
Issue-Nummer
Verlinke Commits mit 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 einzige logische Änderung darstellen. Mische keine nicht verwandten Änderungen.