Sobes.tech
Junior

Wie committest du normalerweise Code?

sobes.tech KI

Antwort von AI

Ich verwende ein standardisiertes Commit-Format, das häufig auf Conventional Commits basiert. Dies sorgt für Einheitlichkeit und automatisiert einige Prozesse, wie die Generierung des Änderungslogs.

Typisches Commit-Format:

<Typ>[(Bereich)]: <Beschreibung>

[<Körper>]

[<Hinweis>]
  • <Typ>: Obligatorisch. Bestimmt den Typ der Änderungen (z.B. feat für neue Funktionalitäten, fix für Fehlerbehebungen, docs für Dokumentationsänderungen, style für Formatierung, refactor für Refactoring, test für Tests, ci für CI/CD-Änderungen).
  • (Bereich): Optional. Gibt den Bereich der Anwendung an, der von den Änderungen betroffen ist (z.B. (Komponente: Button), (Service: Authentifizierung)).
  • <Beschreibung>: Obligatorisch. Kurze und präzise Beschreibung der Änderungen im Imperativ (z.B. "Button hinzufügen", "Validierungsfehler beheben").
  • <Körper>: Optional. Detailliertere Erklärung der Änderungen, Gründe und Kontext. Durch eine leere Zeile von der Beschreibung getrennt.
  • <Hinweis>: Optional. Wird meist verwendet, um BREAKING CHANGE mit Beschreibung anzugeben, warum die Änderung die Rückwärtskompatibilität bricht, oder Links zu Aufgaben (z.B. Closes #123).

Beispiele:

feat: Modal-Komponente hinzufügen
fix(validation): Validierungsfehler bei E-Mail im Registrierungsformular beheben

Die E-Mail wird jetzt gemäß RFC 5322 korrekt validiert.

Closes #45
refactor(component: button): Styles aktualisieren und Zugänglichkeit verbessern

Stil-Refactoring des Buttons, um das Design-System einzuhalten.
Zugänglichkeit durch ARIA-Attribute verbessert.

Dies hilft dem Team, die Änderungsverlauf besser zu verstehen, die Code-Review zu beschleunigen und automatisierte Prozesse zu vereinfachen.