Kā parasti veicat koda commit?

Es izmantoju standartizētu komitu formātu, bieži balstītu uz Conventional Commits. Tas nodrošina vienmērīgumu un automatizē dažus procesus, piemēram, izmaiņu žurnāla ģenerēšanu.

Parasts komitu formāts:

<tips>[(joma)]: <apraksts>

[<saturs>]

[<piezīme>]

• <tips>: Obligāts. Nosaka izmaiņu tipu (piemēram, feat jauna funkcionalitāte, fix kļūdas labojums, docs dokumentācijas izmaiņas, style formatēšana, refactor refaktoringa, test testu pievienošana, ci CI/CD izmaiņas).
• (joma): Neobligāts. Norāda piemērošanas jomu, kurai ietekmē izmaiņas (piemēram, (komponents: poga), (pakalpojums: autentifikācija)).
• <apraksts>: Obligāts. Īss un precīzs izmaiņu apraksts imperatīvā noskaņojumā (piemēram, "pievienot pogu", "labot validācijas kļūdu").
• <saturs>: Neobligāts. Sīkāks izmaiņu skaidrojums, to ieviešanas iemesli un konteksts. Atdala ar tukšu rindu no apraksta.
• <piezīme>: Neobligāts. Parasti tiek izmantots, lai norādītu BREAKING CHANGE ar aprakstu, kāpēc šī izmaiņa pārtrauc atbilstību vai ir saistīta ar uzdevumiem (piemēram, Closes #123).

Piemēri:

feat: pievienot modāla komponentu

fix(validation): labot e-pasta validācijas kļūdu reģistrācijas formā

Tagad e-pasts tiek validēts pareizi saskaņā ar RFC 5322 standartu.

Closes #45

refactor(component: poga): atjaunināt stilus un uzlabot pieejamību

Stilu refaktoringa darbs, lai tas atbilstu dizaina sistēmai.
Uzlabota pieejamība, pievienojot ARIA atribūtus.

Tas palīdz komandai labāk izprast izmaiņu vēsturi, paātrina koda pārskatīšanu un vienkāršo automatizētos procesus.