Sobes.tech
Junior

Kuidas sa tavaliselt koodi commit'id?

sobes.tech AI

Vastus AI-lt

Ma kasutan standardiseeritud commit-formaati, mis sageli põhineb Conventional Commits'il. See tagab järjepidevuse ja automatiseerib teatud protsesse, näiteks muudatuste logi genereerimist.

Tüüpiline commit-formaat:

<liik>[(valdkond)]: <kirjeldus>

[<sisu>]

[<märkused>]
  • <liik>: Kohustuslik. Määrab muudatuse tüübi (näiteks feat uue funktsiooni jaoks, fix vea parandamiseks, docs dokumentatsiooni muudatuste jaoks, style vormindamiseks, refactor refaktoringuks, test testide lisamiseks, ci CI/CD muudatuste jaoks).
  • (valdkond): Valikuline. Näitab rakendusvaldkonda, millele muudatused mõjuvad (näiteks (komponent: nupp), (teenus: autentimine)).
  • <kirjeldus>: Kohustuslik. Lühike ja täpne muudatuste kirjeldus imperatiivses kõneviisis (näiteks "lisa nupp", "paranda valideerimisviga").
  • <sisu>: Valikuline. Detailsem selgitus muudatustest, nende sisseviimise põhjustest ja kontekstist. Eraldub tühja reaga kirjeldusest.
  • <märkused>: Valikuline. Tavaliselt kasutatakse BREAKING CHANGE märkimiseks koos kirjeldusega, miks see muudatus rikub tagasipöördumise või on seotud ülesannetega (näiteks Closes #123).

Näited:

feat: lisa modaalkomponent
fix(validation): paranda e-posti valideerimisviga registreerimisvormil

Nüüd valideeritakse e-posti aadress korrektselt vastavalt RFC 5322 standardile.

Closes #45
refactor(component: nupp): uuenda stiile ja paranda ligipääsetavust

Nupu stiilide refaktorimine vastavusse disainisüsteemiga.
Parandatud ligipääsetavus ARIA-atribuutide lisamisega.

See aitab meeskonnal paremini mõista muudatuste ajalugu, kiirendab koodi ülevaatust ja lihtsustab automatiseeritud protsesse.