Sobes.tech
Junior

Hogyan szoktál kódot commitálni?

sobes.tech MI

Válasz az MI-től

Sablonos commit formátumot használok, amely gyakran a Conventional Commits-en alapul. Ez egységességet biztosít és automatizál bizonyos folyamatokat, például a változásnapló generálását.

Jellemző commit formátum:

<típus>[(terület)]: <leírás>

[<törzs>]

[<megjegyzés>]
  • <típus>: Kötelező. Meghatározza a változtatás típusát (pl. feat új funkciókhoz, fix hibajavításhoz, docs dokumentációs módosításokhoz, style formázáshoz, refactor refaktoráláshoz, test tesztek hozzáadásához, ci CI/CD változtatásokhoz).
  • (terület): Opcionális. Megmutatja az alkalmazás azon területét, amelyet a változtatás érint (pl. (komponens: gomb), (szolgáltatás: hitelesítés)).
  • <leírás>: Kötelező. Rövid és pontos leírása a változtatásoknak felszólító módban (pl. "gomb hozzáadása", "validációs hiba javítása").
  • <törzs>: Opcionális. Részletesebb magyarázat a változtatásokról, okokról és kontextusról. Üres sorral elválasztva a leírástól.
  • <megjegyzés>: Opcionális. Általában a BREAKING CHANGE jelzésére szolgál, leírva, miért törik meg a visszamenőleges kompatibilitást, vagy feladatokra mutató hivatkozások (pl. Closes #123).

Példák:

feat: modális ablak komponens hozzáadása
fix(validáció): email validációs hiba javítása a regisztrációs űrlapon

Mostantól az email helyesen validálódik az RFC 5322 szabvány szerint.

Closes #45
refactor(komponens: gomb): stílusok frissítése és hozzáférhetőség javítása

A gomb stílusainak refaktorálása a dizájn rendszerhez való igazítás érdekében.
A hozzáférhetőség javítása ARIA attribútumok hozzáadásával.

Ez segíti a csapatot abban, hogy jobban megértse a változások történetét, felgyorsítsa a kód felülvizsgálatát és egyszerűsítse az automatizált folyamatokat.