Um eine gute Struktur zu gewährleisten, bitte ich jeden Entwickler, sich an folgende Richtlinien zu halten:
- Im Namen von Repositories sollen die Anfangsbuchstaben großgeschrieben werden; separiert wird mit Bindestrichen
- Commits sollen sich fundamental an Commit-Conventions halten, die hier zu finden sind
- Commits immer in der englischen Sprache
- Präfix vor jeden Commit mit Doppelpunkt in Folge, welche diesen gut zusammenfasst
- Essentiell:
fix:Behebung von Fehlernfeat:Ergänzungen neuer Funktionenrefactor:Veränderungen, die im Frontend nichts verändern (z.B. Performance-Verbesserungen, bessere Struktur des Codes)
- Gelegentlich von Nützen:
chore:Ergänzungen hoher Wichtigkeit (z.B. das Aktualisieren von Abhändigkeiten/Dependencies, etc.)docs:Änderungen von Dokumentationen im Code aber auch README'sstyle:Änderungen der Optik (Ästhethik)
- Essentiell:
- Die Nachricht der Änderung selbst nach dem Präfix soll immer in der
Präsens-Zeitform sein, z.B.add <text>,remove <text>,allow <text>
- Nach dem Präfix und vor dem Doppelpunkt kann ein Ausrufezeichen hinzugefügt werden, wenn der Code noch nicht funktioniert und Fehler aufweist
feat!: <text>refactor!: <text>
- Mit zwei Leerzeilen später lassen sich optional Kommentare und Hinweise verfassen
-
refactor!: <text> <hinweis>
-
- Beispiele für Commits:
feat: send reply to user on command usage,fix: solve memory leak,refactor: restructure function order-
feat!: add licensing This release has not been tested yet and will most likely error.