Apie Conventional Commits formavimo priemonė — Išsamus vadovas
Conventional Commits formavimo priemonė sukuria struktūrizuotus Git commit pranešimus pagal Conventional Commits specifikaciją. Ji padeda programuotojams pasirinkti tipą (Type), apimtį (Scope), temos eilutę (Subject), neprivalomą teksto aprašymą (Body) ir poraštės problemas (Footer).
Lengvai pažymėkite nesuderinamus pakeitimus naudodami šauktuko sintaksę (`type!: description`), nurodykite išspręstas problemas (`Closes #123`) ir gaukite standartizuotus commit pranešimus, pritaikytus automatiniams įrankiams, tokiems kaip `semantic-release` bei automatiniams pakeitimų žurnalų (changelog) generatoriams.
Pagrindinės funkcijos ir galimybės
- Išsamus tipų katalogas: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
- Neprivaloma apimties (scope) įvestis ir realaus laiko temos ilgio bei liepiamosios nuosakos priminimai
- Nesuderinamų pakeitimų (Breaking Change) jungiklis vienu spustelėjimu, pritaikantis standartinę šauktuko (`!`) sintaksę
- Automatinis problemų susiejimo poraštės generatorius su `git commit -m` komandos kopijavimu vienu spustelėjimu
Kaip naudoti
- 1
Pasirinkite commit tipą (pvz., `feat` naujoms funkcijoms, `fix` klaidų taisymams).
- 2
Nurodykite neprivalomą apimtį (pvz., `api`, `auth`) ir glaustą aprašymą liepiamąja nuosaka.
- 3
Peržiūrėkite suformuotą commit eilutę ir nukopijuokite visą `git commit` komandą savo terminalui.
Dažniausi naudojimo atvejai
- → Inžinierių komandų įtraukimas į nuoseklius Git commit istorijos standartus
- → Semantinio versijų didinimo ir automatinių laidos pastabų generavimo automatizavimas CI/CD konvejeriuose
- → Atgalinio suderinamumo neturinčių API nesuderinamų pakeitimų (breaking changes) žymėjimas atliekant didelius bibliotekų atnaujinimus
Susiję įrankiai
HTML meta žymų ir SEO generatorius
Generuokite teisingas HTML meta žymas, Open Graph ir Twitter Cards socialiniams tinklams ir paieškai.
Gitignore failų generatorius
Generuokite išsamius .gitignore failus pagal operacinę sistemą, kalbą ir kūrimo įrankį.
Atvirojo kodo licencijų generatorius
Pasirinkite ir generuokite MIT, Apache 2.0, GPL, BSD ir kitas atvirojo kodo licencijas savo projektui.
README failų kūrimo priemonė
Kurkite profesionalius projekto README.md dokumentus su ženkliukais, skiltimis ir instrukcijomis.
Semver versijų skaičiuotuvas
Apskaičiuokite kitą semantinę versiją (major, minor, patch) ir patikrinkite atitiktį rėžiams.
OpenAPI / Swagger peržiūros priemonė
Peržiūrėkite ir testuokite OpenAPI 3.0 ir Swagger 2.0 API specifikacijas interaktyvioje sąsajoje.
Dažniausiai užduodami klausimai ir privatumas
Koks semantinės versijos padidinimas atitinka kiekvieną commit tipą?
Pagal standartines Conventional Commits taisykles, `fix` sukelia PATCH padidinimą, `feat` sukelia MINOR padidinimą, o bet kuris commit su `BREAKING CHANGE` sukelia MAJOR padidinimą.
Ar temos eilutė turėtų baigtis tašku?
Ne. Conventional Commits geroji praktika rekomenduoja glaustą sakinį liepiamąja nuosaka be taško pabaigoje (pvz., `feat: allow user avatar upload`).