Conventional Commits abiline

Loo standardiseeritud Giti commit-sõnumeid vastavalt Conventional Commits spetsifikatsioonile.

0/72

Täida kirjeldus, et commit-sõnumit eelvaadata

Conventional Commits vorming

<type>[scope]: <description>

[optional body]

[optional footer(s)]

Levinud näited

Conventional Commits abiline — Üksikasjalik juhend

Kategooria: DevOps ja standardid 100% lokaalselt brauseris

Conventional Commit generaator koostab struktureeritud Giti commit-sõnumeid vastavalt Conventional Commits spetsifikatsioonile. See juhendab arendajaid tüübi (Type), ulatuse (Scope), teemarea (Subject), valikulise sisu kirjelduse (Body) ja jaluse probleemiviidete (Footer) valimisel.

Märgi ühildumatud muudatused hõlpsalt hüüumärgi süntaksiga (`type!: description`), viita lahendatud probleemidele (`Closes #123`) ja väljasta standardiseeritud commit-sõnumeid, mis toetavad automatiseeritud tööriistu nagu `semantic-release` ja automaatsed muudatuste logi generaatorid.

#git #commit #conventional #message #changelog

Põhifunktsioonid ja võimalused

  • Täielik tüüpide kataloog: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
  • Valikuline ulatuse sisend ja reaalajas teemarea pikkuse ning käskiva kõneviisi meeldetuletused
  • Ühe klõpsuga ühildumatu muudatuse (Breaking Change) lüliti, mis rakendab standardset hüüumärgi (`!`) süntaksit
  • Automaatne probleemiviidetega jaluse generaator koos `git commit -m` käsu kopeerimisega ühe klõpsuga

Kuidas kasutada

  1. 1

    Vali commit'i tüüp (nt `feat` funktsioonide või `fix` veaparanduste jaoks).

  2. 2

    Määra valikuline ulatus (nt `api`, `auth`) ja lakooniline käskivas kõneviisis kirjeldus.

  3. 3

    Vaata koostatud commit-sõne üle ja kopeeri oma terminali jaoks täielik käsk `git commit`.

Levinud kasutusjuhud

  • → Insenerimeeskondade juhendamine järjekindlate Giti commit-ajaloo standardite järgimisel
  • → Semantiliste versioonitõstmiste ja automaatsete väljalaskemärkmete automatiseerimine CI/CD konveierites
  • → Tagasiühildumatute API muudatuste märkimine teekide suurte versiooniuuenduste ajal

Seotud tööriistad

Korduma kippuvad küsimused ja privaatsus

Milline semantilise versiooni tõstmine vastab igale commit-tüübile?

Vastavalt tavapärastele Conventional Commits kokkulepetele käivitab `fix` PATCH-tõstmise, `feat` MINOR-tõstmise ja iga commit, mis sisaldab märget `BREAKING CHANGE`, käivitab MAJOR-tõstmise.

Kas teemarida peaks lõppema punktiga?

Ei. Conventional Commitsi parimad tavad soovitavad lühikest käskivas kõneviisis lauset ilma lõpp-punktita (nt `feat: allow user avatar upload`).