Tööriista kirjeldus

Branch Name Generator on arendajate tööriist, mis aitab luua õigesti vormindatud Git harunimesid, järgides Git haru nime parimaid tavasid. Olgu tegemist JIRA piletitega või lihtsate tekstikirjeldustega, see Git haru looja ekstraheerib automaatselt piletite ID-d (nt PROJ-123) teie sisendist, puhastab teksti ja vormindab kõik vastavalt tavapärastele Git harude konventsioonidele. Kui olete kunagi mõelnud, kuidas Git harusid järjepidevalt nimetada, tagab see tööriist, et kogu teie meeskond järgib standardiseeritud harunime mustreid.

Funktsioonid

  • JIRA piletite ekstraheerimine: Avastab ja ekstraheerib automaatselt JIRA piletite ID-d (nt PROJ-123) teie sisendist
  • Harutüübi prefiksid: Valige levinud harutüübid (feature, bugfix, hotfix, release, chore, refactor, docs, test või ilma prefiksita)
  • Kohandatav eraldaja: Kasutage sidekriipse, alakriipse või mis tahes muud märki sõnade eraldajana
  • Pikkuse piiramine: Määrake harunime maksimaalne pikkus, et järgida repositooriumi poliitikaid
  • Automaatne puhastamine: Eemaldab erimärgid, normaliseerib tühikuid ja teisendab väiketähtedeks
  • Kohene eelvaade: Vaadake genereeritud harunime värskendamist reaalajas, kui kirjutate
  • Kopeeri lõikelauale: Kopeerige genereeritud harunimi kiiresti ühe klõpsuga

Kasutusjuhtumid

  • Git harude nimetamise õppimine: Ideaalne arendajatele, kes õpivad Git haru nime parimaid tavasid ja standardiseeritud nimetamisreegleid
  • Funktsiooniharude loomine: Looge järjepidevaid harunimesid uutele funktsioonidele, näiteks feature/PROJ-123/add-user-authentication
  • Veaparandused: Vormindage veaparanduste harusid, näiteks bugfix/PROJ-456/fix-login-error
  • Kiirparandused: Looge kiireloomulisi paranduste harusid, näiteks hotfix/PROJ-789/security-patch
  • Meeskonna järjepidevus: Tagage, et kõik meeskonnaliikmed järgiksid sama harunime konventsiooni selle harunime generaatori abil
  • Kiire haru loomine: Kiirendage oma töövoogu, kasutades seda Git haru looja, et genereerida nimesid koheselt, selle asemel, et neid käsitsi vormindada
  • Repositooriumi nõuetele vastavus: Järgige maksimaalse harunime pikkuse piiranguid, mida kehtestab teie Git hostimise platvorm

Harutüübid

  • feature: Uute funktsioonide ja funktsionaalsuse jaoks
  • bugfix: Tavapäraste veaparanduste jaoks
  • hotfix: Kiireloomuliste tootmisparanduste jaoks
  • release: Väljalaske ettevalmistuse harusid
  • chore: Hooldustööde ja värskenduste jaoks
  • refactor: Koodi refaktoreerimise jaoks
  • docs: Dokumentatsiooni värskenduste jaoks
  • test: Testimisega seotud muudatuste jaoks
  • none: Loob harunimed ilma tüübiprefiksita

Git harunime parimad tavad

Git harude nimetamise mõistmine on oluline puhta repositooriumi säilitamiseks. Genereeritud harunimed järgivad seda struktuuri, mis põhineb tööstusharu standardsetel Git harunime parimatel tavadel:

[branch-type]/[TICKET-ID]/[description-with-separators]

Näited õigesti vormindatud Git harunimedest:

  • Sisend: PROJ-123 Add user authentication
    Väljund: feature/PROJ-123/add-user-authentication

  • Sisend: Fix login error
    Väljund: bugfix/fix-login-error

  • Sisend: Update documentation for API
    Väljund: docs/update-documentation-for-api