Konvencionális commit felépítő

Konvencionális commit felépítő

A Konvencionális Commits az "type(scope): description" formátum, amelyet a changelog generátorok, a semantic-release és a commitlint egyaránt elvárnak. Ez az eszköz összeállít egyet neked: válassz egy típust, adj meg egy opcionális hatókört, írd meg a leírást, és az összeállítja a fejlécet — valamint egy törzset és egy láblécet jegyazonosítókkal, ha hozzáadod. Válts az ellenőrzés módra az ellenkező irányban: illessz be egy vagy több meglévő commit üzenetet, egy soronként, és pontosan lát, hogy mi a baj az egyes üzenetekkel.

A típuslista a szabványos készletet tartalmazza — feat, fix, docs, style, refactor, perf, test, build, ci, chore és revert. A kívül esik az interfészen kapcsoló ! jelöléssel látja el a fejlécet, és miután megjegyzést adsz, hozzáfűzi a BREAKING CHANGE: láblécsort, pontosan úgy, ahogy a specifikáció elvárja. A fejléc max hossza lehetőség érvényesíti a hosszúsági költségvetést, amelyen a csapatod megállapodott (a commitlint saját alapértelmezése 72 karakter); a kisbetű kezdés kényszerítése és a záró pont tiltása a két stílus szabály, amely a legtöbb commit linter alapértelmezés szerint ellenőrz, és mindkettő kikapcsolható, ha a csapatod nem használja.

Az ellenőrzés módban az egyes sorok egy teljes commit fejlécként kezelendők, így a git log --oneline kimenetének beillesztése egy egész köteg ellenőrzésére szolgál. Válassz, hogy a kimenet egy jelentés — az eredeti sor, amely után mit kell javítani — vagy a korrigált üzenet, automatikusan kisbetűvel kezdve és de-pontozva, ahol az egyértelmű. Az olyan sor, amely egyáltalán nem követi a type(scope): description alakzatot, érintetlenül marad a helyett, hogy megpróbálnánk találgatni.

Minden a böngésződben fut, így a privát tárolóból származó commit üzenetek soha nem hagyják el az eszközöd. Másold ki az eredményt, töltsd le .txt fájlként, vagy küldd vissza a bemenetre, hogy tovább finomítsd.

Gyakori kérdések