Kaip paprastai darote kodo commit'us?

Aš naudoju standartizuotą įrašų formatą, dažnai pagrįstą Conventional Commits. Tai užtikrina nuoseklumą ir automatizuoja kai kuriuos procesus, pavyzdžiui, pakeitimų žurnalo generavimą.

Įprastas įrašo formatas:

<tipas>[(sritis)]: <aprašymas>

[<turinys>]

[<pastaba>]

• <tipas>: Privalomas. Nustato pakeitimų tipą (pvz., feat naujai funkcijai, fix klaidos taisymui, docs dokumentacijos pakeitimams, style formatavimui, refactor refaktoringui, test testų pridėjimui, ci CI/CD pakeitimams).
• (sritis): Neprivalomas. Nurodo taikomos srities, kuriai įtakoja pakeitimai, pavadinimą (pvz., (komponentas: mygtukas), (paslauga: autentifikacija)).
• <aprašymas>: Privalomas. Trumpas ir tikslus pakeitimų aprašymas veikiant veiksmažodžio nuomone (pvz., "pridėti mygtuką", "pataisyti validacijos klaidą").
• <turinys>: Neprivalomas. Detalesnis pakeitimų paaiškinimas, jų įvedimo priežastys ir kontekstas. Skiriamas tuščia eilute nuo aprašymo.
• <pastaba>: Neprivaloma. Paprastai naudojama nurodyti BREAKING CHANGE su aprašymu, kodėl šis pakeitimas pažeidžia suderinamumą, arba nuorodomis į užduotis (pvz., Closes #123).

Pavyzdžiai:

feat: pridėti modalo komponentą

fix(validation): pataisyti el. pašto validacijos klaidą registracijos formoje

Dabar el. paštas validuojamas teisingai pagal RFC 5322 standartą.

Closes #45

refactor(component: mygtukas): atnaujinti stilius ir pagerinti prieinamumą

Mygtuko stilių refaktoringas, kad atitiktų dizaino sistemą.
Pagerintas prieinamumas pridėjus ARIA atributus.

Tai padeda komandai geriau suprasti pakeitimų istoriją, pagreitina kodo peržiūrą ir supaprastina automatizuotus procesus.