Preskoči na vsebino
100% lokalno

Graditelj sporočila Conventional Commits

Sestavite sporočilo Conventional Commits iz vrste, obsega in opisa ali preverite obstoječa sporočila za težave.

Vhod
Izhod

Graditelj sporočila Conventional Commits

Conventional Commits je oblika »vrsta(obseg): opis« ki ga pričakujejo generatorji sprememb, semantic-release in commitlint. To orodje ga zgradi za vas: izberite vrsto, dodajte izbirni obseg, napišite opis in sastavlja glavo — skupaj s telesom in nogo s sklici na kartice, če jih dodate. Preklopite se v način preverjanja da naredite nasprotno: prilepite eno ali več obstoječih sporočil, eno na vrstico, in vidite natanko kaj je narobe z vsakim.

Seznam vrst zajema standardni niz — feat, fix, docs, style, refactor, perf, test, build, ci, chore in revert. Preklop radikalne spremembe zaznamuje glavo z »!« in, ko dodate opombo, doda vrstico noge »BREAKING CHANGE:«, točno kot specifikacija pričakuje. Možnost največje dolžine glave uvaja proračun dolžine, ki ga je vaš tim dogovoril (privzeta nastavka commitlint je 72 znakov); prisila majhnih začetnih črk in prepoved končne pike sta dve pravili slogov, ki jih večina preverjačev sporočil preveri po privzeti vrednosti, in oba se lahko izključita če vaš tim ju ne uporablja.

V načinu preverjanja se vsaka vrstica obravnava kot ena celotna glava sporočila, zato je lepljenje rezultata »git log --oneline« celovit pregled. Izberite ali je rezultat poročilo — izvirna vrstica, ki ji sledi kaj je potrebno popraviti — ali popravljeno sporočilo, samodejno z malimi črkami in brez ločil kjer je to jasno. Vrstica, ki sploh ne sledi obliki vrsta(obseg): opis ostane nespremenjena namesto da se uganjevati.

Vsega se izvršava v vaši brskalniki, zato se sporočila poruke iz zasebnega skladišča nikada ne zapustijo vaše naprave. Kopirajte rezultat, preuzmite ga kot datoteko .txt, ali ga pošljite nazaj v vhod za nadaljnje izboljšave.

FAQ

Kaj je Conventional Commit?
Sporočilo sporočila napisano kot »vrsta(obseg): opis«, ki mu sledi telo in noga. Orodja kot commitlint, semantic-release in generatorji sprememb razčlenjujejo to obliko da se odločijo za različice in skupino opomb izdaje.
Kako deluje način preverjanja?
Prilepite eno sporočilo poruke na vrstico — samo glavo, kot vrstico iz »git log --oneline«. Vsaka vrstica je potrdjena glede na seznam vrst, omejitve dolžine glave in vaša pravila majhnih črk/pik, in poročana posebej.
Kako označiti radikalno spremembo?
Vključite »Radikalna sprememba« in dodajte opombo. Glava dobi »!« pred dvopičjem in, ko je opomba ne-prazna, vrstica noge »BREAKING CHANGE: …« je dodana, kar ustreza specifikaciji Conventional Commits.
Ali lahko dodam reference listin v nogo?
Da — napišite jih v polje noge, npr. »Closes #123, refs JIRA-456«. To je dodano kot lastna vrstica po telesu.
Je moja zgodovina sporočila negdje naložena?
Ne. Gradnja in preverjanje sporočil poruke se izvršuje v celoti v vaši brskalniki — nič od tega, kar napišete ali prilepite, ni poslano na strežnik.