A(z) Conventional Commits segéd bemutatása — Részletes útmutató
A Conventional Commit Generator strukturált Git commit üzeneteket hoz létre a Conventional Commits specifikáció előírásai szerint. Végigvezeti a fejlesztőket a Type, Scope, tárgysor (Subject), az opcionális leírás (Body) és a láblécben szereplő hibajegyek (Footer) kiválasztásán.
Könnyedén megjelölhetők a kompatibilitást törő változások (breaking change) a felkiáltójeles szintaxissal (`type!: description`), hivatkozhatók a lezárt hibajegyek (`Closes #123`), és olyan szabványos commit üzenetek állíthatók elő, amelyek támogatják az automatizált eszközöket, mint a `semantic-release` és az automatikus változásnapló-generátorok.
Főbb funkciók és képességek
- Teljes típuskatalógus: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
- Opcionális hatókör (scope) megadás és valós idejű tárgysorhossz-, illetve felszólító mód emlékeztetők
- Egykattintásos Breaking Change kapcsoló a szabványos felkiáltójeles (`!`) szintaxis alkalmazásával
- Automatikus hibajegy-összekapcsoló láblécgenerátor egykattintásos `git commit -m` másolással
Használati útmutató
- 1
Válaszd ki a commit típusát (pl. `feat` új funkciókhoz, `fix` hibajavításokhoz).
- 2
Adj meg egy opcionális hatókört (pl. `api`, `auth`) és egy tömör, felszólító módban írt leírást.
- 3
Tekintsd át az összeállított commit szöveget, és másold ki a teljes `git commit` parancsot a terminálodhoz.
Gyakori felhasználási esetek
- → Fejlesztőcsapatok betanítása a következetes Git commit előzményi szabványokra
- → Szemantikus verzióléptetések és automatikus kiadási megjegyzések automatizálása CI/CD folyamatokkal
- → Visszafelé nem kompatibilis API törő változások (breaking changes) megjelölése nagyobb könyvtárfrissítéseknél
Kapcsolódó eszközök
HTML Meta Tag és Open Graph generátor
SEO meta címkék, Open Graph és Twitter kártyák beállítása élő közösségi előnézettel.
.gitignore sablon generátor
Népszerű nyelvekhez és keretrendszerekhez (Node, Python, Go, Java) illő .gitignore készítése.
Nyílt forráskódú licenc generátor
MIT, Apache 2.0, GPL v3 és egyéb nyílt forráskódú licencek testreszabása és exportálása.
README.md sablongenerátor
Strukturált és professzionális README dokumentáció készítése GitHub projektekhez.
SemVer szemantikus verziókalkulátor
Szemantikus verziószámok (SemVer) léptetése és kompatibilitásának ellenőrzése.
OpenAPI / Swagger dokumentáció-néző
OpenAPI és Swagger specifikációk (JSON/YAML) renderelése interaktív API dokumentációként.
Gyakori kérdések és adatvédelem
Milyen szemantikus verziólépés tartozik az egyes commit típusokhoz?
A szabványos Conventional Commits konvenciók szerint a `fix` típus PATCH léptetést, a `feat` MINOR léptetést, míg minden `BREAKING CHANGE` megjelölésű commit MAJOR verzióléptetést vált ki.
Szabad ponttal zárni a tárgysort?
Nem. A Conventional Commits bevált gyakorlatai szerint a tárgysor egy rövid, záró pont nélküli felszólító mondat legyen (pl. `feat: allow user avatar upload`).