Ինչպես ստեղծել ձևաչափված Git commit հաղորդագրություն

Ինչի համար է նախատեսված գործիքը

Այս գործիքը նախատեսված է Git-ի համար ձևաչափված commit հաղորդագրություն ստանալու նպատակով։ Այն հարմար է, երբ ցանկանում եք նախապես սահմանել փոփոխության տեսակը, ընտրովի շրջանակը, հաղորդագրության տեքստը և breaking change-ի նշումը, իսկ հետո ստանալ մեկ պատրաստի տեքստ՝ վերանայելու և ձեր աշխատանքային հոսքում օգտագործելու համար։ Գործիքը Git հրաման չի կատարում և պահոցում փոփոխություն կամ commit չի կիրառում, ուստի արդյունքը պետք է դիտարկել որպես հաղորդագրության տեքստ, ոչ թե արդեն ստեղծված commit։

Մուտքերը կարող եք լրացնել մասամբ։ Եթե հաղորդագրության դաշտը դատարկ է, տեքստը կազմվում է ներկառուցված ձևանմուշներից և բառերի ցանկերից։ Եթե տեսակը չեք տրամադրում կամ այն ճանաչված տարբերակ չէ, ընտրվում է ներկառուցված հավաքածուից։ Շրջանակի դատարկ լինելու դեպքում նույնպես ընտրվում է ներկառուցված հավաքածուից, իսկ լրացված շրջանակը տեղադրվում է փակագծերում։ Breaking change-ի ընտրանքը լռելյայն անջատված է։

Ինչպես ստանալ հաղորդագրությունը

Որոշեք, թե ինչ տեղեկություն եք ցանկանում ներառել։ Փոփոխության տեսակը լրացրեք ճանաչված արժեքով, եթե ցանկանում եք այն վերահսկել։ Շրջանակը լրացրեք միայն այն դեպքում, երբ անհրաժեշտ է նշել փոփոխված ենթահամակարգը կամ հատվածը։
Մուտքագրեք հաղորդագրության տեքստը։ Ոչ դատարկ տեքստի դեպքում գործիքը օգտագործում է ձեր տրամադրած հաղորդագրությունը։ Եթե դաշտը թողնեք դատարկ, գործիքը պատահականորեն ընտրում է ներկառուցված ձևանմուշ և բառեր՝ հաղորդագրության տեքստ կազմելու համար։ Այդ պատճառով դատարկ դաշտով ստացված արդյունքը կարող է տարբեր լինել տարբեր գործարկումների ժամանակ։
Անհրաժեշտության դեպքում միացրեք breaking change-ի ընտրանքը։ Միացված լինելու դեպքում ստեղծված տեքստին ավելացվում է դատարկ տողով առանձնացված breaking-change ծանուցում։ Եթե ընտրանքը չմիացնեք, այդ ծանուցումը չի ավելացվում այդ մուտքի հիման վրա։
Գործարկեք գեներացումը և կարդացեք վերադարձված հաղորդագրությունը։ Եթե տեսակը լրացված և ճանաչված է, այն օգտագործվում է։ Լրացված շրջանակը հայտնվում է փակագծերում, իսկ դատարկ շրջանակի դեպքում ընտրվում է ներկառուցված տարբերակ։ Վերջում գործիքը ավելացնում է դատարկ տող և երեք հաստատուն կետային տող։
Վերանայեք արդյունքը նախքան այն ձեր պահոցում կիրառելը։ Ստուգեք, որ տեսակը, շրջանակը, նկարագրությունը և breaking change-ի ծանուցումը համապատասխանում են փոփոխությանը։ Գործիքը ստեղծում է հաղորդագրության տեքստ, բայց չի կատարում Git գործողություն, չի ստեղծում commit և չի կիրառում այդ տեքստը պահոցում։

Ինչպես կարդալ արդյունքը

Արդյունքը ձևաչափված Git commit հաղորդագրության տեքստ է։ Դրա կառուցվածքում կարող եք տեսնել տեսակի և, ոչ դատարկ լինելու դեպքում, շրջանակի օգտագործումը, ապա հաղորդագրության տեքստը։ Ձեր տրամադրած ոչ դատարկ հաղորդագրությունը պահպանվում է որպես հաղորդագրության բովանդակություն։ Դատարկ մուտքի դեպքում բովանդակությունը ընտրվում է ներկառուցված ձևանմուշներից և բառերից, հետևաբար այն պետք է իմաստով ստուգել։

Breaking change-ի ընտրանքը միացնելու դեպքում փնտրեք դատարկ տողից հետո ավելացված breaking-change ծանուցումը։ Արդյունքի վերջում ևս կա դատարկ տող և երեք հաստատուն կետային տող։ Այդ կառուցվածքը ցույց է տալիս, թե ինչ է վերադարձրել գործիքը, բայց ինքնին չի հաստատում, որ հաղորդագրությունը համապատասխանում է ձեր պահոցի կանոններին կամ տվյալ փոփոխության իմաստին։

Եթե մշակման ընթացքում բացառություն առաջանա, գործիքը հայտնում է ձախողման մասին և ներառում է բացառության տեքստը։ Այդ դեպքում մի օգտագործեք կիսատ կամ չհասկանալի արդյունքը. ստուգեք մուտքերը և կրկին փորձեք։ Քանի որ գործիքի պայմանագիրը ցանցային հասանելիությունը նշում է որպես անջատված, արտաքին տվյալների աղբյուրից բովանդակություն ստանալու վարք չի նկարագրված։ Սա, սակայն, չի սահմանում տվյալների պահպանման կամ տեղակայման պայմանները։

Գործնական օրինակ

Մշակողը պատրաստում է օգտատիրոջ միջերեսի փոփոխության commit հաղորդագրություն և ցանկանում է, որ այն ունենա ui շրջանակ ու breaking change-ի նշում։

Մշակողը թողնում է հաղորդագրության դաշտը դատարկ, ընտրում է ճանաչված տեսակը, լրացնում է ui շրջանակը և միացնում է breaking change-ի ընտրանքը, ապա գործարկում է գեներացումը։

Վերադարձված տեքստում տեսակի և շրջանակի կառուցվածքին հաջորդում է ներկառուցված ձևանմուշից կազմված հաղորդագրություն, ապա breaking-change ծանուցում, իսկ վերջում՝ երեք հաստատուն կետային տող։ Պատահական ընտրությունների պատճառով կոնկրետ բառերը նախապես որոշված չեն։

Սահմանափակումներ

Գործիքը վերադարձնում է հաղորդագրության տեքստ. տրամադրված փաստերը չեն հաստատում դրա համապատասխանությունը կոնկրետ պահոցի կանոններին և չեն ցույց տալիս, որ այն կիրառվում է պահոցում։
Ցանցային հասանելիությունը հայտարարված է որպես անջատված, սակայն այդ փաստը չի սահմանում գործիքի տեղակայումը կամ տվյալների պահպանման պայմանները։

Հաճախակի սխալներ

Եթե տեսակը կամ շրջանակը թողնեք դատարկ, գործիքը կարող է ընտրել ներկառուցված տարբերակ, իսկ դատարկ հաղորդագրության դեպքում նաև ինքնուրույն կազմել տեքստ։ Վերահսկելի արդյունքի համար լրացրեք ճանաչված տեսակը, անհրաժեշտ շրջանակը և ոչ դատարկ հաղորդագրությունը։

Հաճախ տրվող հարցեր

Կարո՞ղ եմ օգտագործել իմ commit հաղորդագրությունը։

Այո, եթե տրամադրեք ոչ դատարկ հաղորդագրության տեքստ, այն օգտագործվում է որպես հաղորդագրության բովանդակություն։ Դատարկ դաշտի դեպքում տեքստը կազմվում է ներկառուցված ձևանմուշներից և բառերից։

Ի՞նչ է անում breaking change-ի ընտրանքը։

Միացնելու դեպքում breaking change-ի ընտրանքը հաղորդագրությանը ավելացնում է դատարկ տողով առանձնացված ծանուցում։

Գործիքը commit ստեղծո՞ւմ է պահոցում։

Ոչ։ Գործիքը վերադարձնում է ձևաչափված հաղորդագրության տեքստ և չի կատարում Git հրաման կամ commit չի ստեղծում։