Conventional Commits abiline — Üksikasjalik juhend
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.
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
Vali commit'i tüüp (nt `feat` funktsioonide või `fix` veaparanduste jaoks).
- 2
Määra valikuline ulatus (nt `api`, `auth`) ja lakooniline käskivas kõneviisis kirjeldus.
- 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
HTML Meta siltide ja Open Graphi generaator
Genereeri SEO ja sotsiaalmeedia (Open Graph, Twitter Card) meta-silte koos reaalajas eelvaatega.
.gitignore faili generaator
Genereeri optimaalseid .gitignore faile programmeerimiskeeltele, raamistikele ja operatsioonisüsteemidele.
Avatud lähtekoodi litsentsi generaator
Vali ja genereeri populaarseid avatud lähtekoodi tarkvaralitsentse (MIT, Apache 2.0, GPLv3, BSD).
GitHub README.md generaator
Genereeri professionaalseid ja struktureeritud GitHubi projekti README.md faile mallide abil.
SemVer semantilise versioonihalduse kalkulaator
Kontrolli ja võrdle SemVer versioone, arvuta järgmisi versioone ja kontrolli vahemikke.
OpenAPI / Swagger vaataja
Visualiseeri ja testi OpenAPI (Swagger 2.0 / 3.0) YAML ja JSON spetsifikatsioone interaktiivselt.
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`).