Sobes.tech
Junior

Hoe commit je meestal code?

sobes.tech AI

Antwoord van AI

Ik gebruik een gestandaardiseerd commit-formaat, vaak gebaseerd op Conventional Commits. Dit zorgt voor consistentie en automatiseert sommige processen, zoals het genereren van de changelog.

Typisch commit-formaat:

<type>[(gebied)]: <beschrijving>

[<body>]

[<notitie>]
  • <type>: Verplicht. Bepaalt het type wijziging (bijvoorbeeld feat voor nieuwe functionaliteit, fix voor bugfixes, docs voor documentatiewijzigingen, style voor opmaak, refactor voor refactoring, test voor tests toevoegen, ci voor CI/CD wijzigingen).
  • (gebied): Optioneel. Geeft het toepassingsgebied aan dat wordt beïnvloed door de wijziging (bijvoorbeeld (component: knop), (dienst: authenticatie)).
  • <beschrijving>: Verplicht. Korte en precieze beschrijving van de wijziging in imperatieve vorm (bijvoorbeeld "knop toevoegen", "validatiefout corrigeren").
  • <body>: Optioneel. Meer gedetailleerde uitleg van de wijziging, redenen en context. Gescheiden door een lege regel van de beschrijving.
  • <notitie>: Optioneel. Wordt meestal gebruikt om BREAKING CHANGE aan te geven met een beschrijving waarom het de achterwaartse compatibiliteit breekt, of links naar taken (bijvoorbeeld Closes #123).

Voorbeelden:

feat: modale venster component toevoegen
fix(validatie): e-mail validatiefout in registratieformulier corrigeren

Nu wordt de e-mail correct gevalideerd volgens RFC 5322.

Closes #45
refactor(component: knop): stijlen bijwerken en toegankelijkheid verbeteren

Refactoring van de stijlen van de knop om te voldoen aan het ontwerp-systeem.
Toegankelijkheid verbeterd door ARIA-attributen toe te voegen.

Dit helpt het team om de wijzigingsgeschiedenis beter te begrijpen, code review te versnellen en geautomatiseerde processen te vereenvoudigen.