Conventional Commits formavimo priemonė

Formatuokite standartizuotus Git commit pranešimus pagal Conventional Commits standartą.

0/72

Užpildykite aprašymą, kad peržiūrėtumėte commit pranešimą

Conventional Commits formatas

<type>[scope]: <description>

[optional body]

[optional footer(s)]

Dažni pavyzdžiai

Apie Conventional Commits formavimo priemonė — Išsamus vadovas

Kategorija: DevOps ir standartai 100 % lokaliai naršyklėje

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.

#git #commit #conventional #message #changelog

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. 1

    Pasirinkite commit tipą (pvz., `feat` naujoms funkcijoms, `fix` klaidų taisymams).

  2. 2

    Nurodykite neprivalomą apimtį (pvz., `api`, `auth`) ir glaustą aprašymą liepiamąja nuosaka.

  3. 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

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`).