Како написати ефикасну, корисну Гит Цоммит поруку

Поруке урезивања су кратки описи сваког урезивања у систему контроле верзија као што је Гит. Када унесете промене у датотеке пројекта, требало би да наведете поруку која објашњава шта оне раде или зашто сте их направили.

Поруке за урезивање служе као облик документације и комуникације. Они играју кључну улогу у одржавању јасне и организоване историје верзија пројекта. Научите како да пишете добре поруке о обавези и други чланови вашег тима ће још више ценити ваш рад.

Структура поруке о доброј обавези

Добар пример поруке урезивања укључује четири одељка: Тип, Опис, Тело и Подножје.

Овако:

: 
[опционо тело]
[опционо подножје]

Тип

Тип описује врсту промене направљене у садашњем урезивању. Можете користити било који систем који има смисла у вашим околностима. На пример, ево неких примера кључних речи које можете да користите да сигнализирате сваку врсту промене, уз пример употребе:

• феат: ваше промене уводе нову функцију.
• поправити: поправљате грешку.
• рефактор: ваша промена рефакторира код без поправљања грешке или додавања нове функције.
• тест: правите све промене везане за тестирање. На пример, када ви писати тестове са Јестом или било други оквир за тестирање ви бирате.
• цхоре: промене које се не односе на исправку, функцију или тест. На пример, ажурирање зависности.
• доцс: када ажурирате документацију.
• стил: промене које не утичу на значење кода, као што је додавање белог размака, недостајуће тачке и зарезе, итд.
• перф: промене које се односе на побољшања перформанси.
• градити: када унесете промене које утичу на датотеке за изградњу.
• ци: промене везане за континуирану интеграцију.
• вратити се: када се враћате на претходно урезивање.

Опис

„Опис“ поруке урезивања је сажет и дескриптиван резиме промена направљених у урезивању. Служи као наслов који обухвата суштину обавезивања.

Када пишете опис, имајте на уму следеће:

• Нека буде јасно и довољно конкретно да на први поглед опишете обавезу.
• Нека буде кратак и концизан. У идеалном случају, ограничити га на 50 знакова или мање.
• Напишите га у садашњем времену, чак и ако описујете већ направљене промене.
• Искористите императив док га пишете.
• Почните га великим словом.
• Не завршавајте то са периодом.

На пример:

подвиг: Имплементирајте прекидач тамног режима за почетну страницу

Овај пример показује како можете написати опис за урезивање имплементира тамни режим. Користи се феат тип јер уводи нову функцију.

Тело (опционо)

Одељак тела поруке урезивања пружа додатне детаље и контекст о променама направљеним у урезивању. Неће вам увек требати тело, али може да вам помогне да пружите више информација, објасните образложење промене или опишете било која техничка разматрања.

Ево неколико ствари које треба имати на уму док пишете део тела поруке урезивања:

• Гит никада не премотава текст аутоматски, па га ручно премотајте на 72 знака када пишете тело. Ово Гиту даје довољно простора за увлачење текста, чинећи га читљивијим.
• Користите тело да објасните шта се догодило у промени, зашто сте направили промену и разлоге за вашу промену.
• Морате да оставите празан ред између реда за опис и тела. Ово омогућава Гиту да их разликује.
• Ако урезивање уводи више промена или утиче на различите области кодне базе, размислите о коришћењу тачака или пасуса да бисте разбили модификације. Ово побољшава читљивост и помаже читаоцима да разумеју различите аспекте урезивања.

На пример:

феат: Додајте ГитХуб као ОАутх провајдера
Интегришите ГитХуб као ОАутх добављача да бисте омогућили беспрекорно 
аутентификацију са ГитХуб налозима.
– Имплементирајте ток ОАутх аутентикације помоћу ГитХуб АПИ-ја
- Конфигуришите неопходне крајње тачке и подешавања за ГитХуб аутентификацију
- Ажурирајте кориснички интерфејс да бисте укључили опцију пријављивања на ГитХуб

Горњи пример показује добру поруку Гит урезивања за функцију која додаје ГитХуб као ОАутх провајдер на вашу пријаву. Ова порука урезивања има сажети ред (50 знакова или мање), детаљнији текст објашњења (умотан на око 72 знака) и тачке за набрајање за додатне информације.

Одељак подножја у поруци урезивања је опциони део који пружа додатне информације или метаподатке који се односе на урезивање. Обично се поставља после дела тела, одвојено празном линијом. Подножје може да садржи различите врсте информација, као што су референце на сродна питања, ознаке или посебне напомене.

Када упућујете на проблеме, захтеве за повлачење или друге повезане ставке, користите одговарајућу синтаксу или формат који захтева систем за праћење проблема вашег пројекта. Ово осигурава да су референце правилно препознате и повезане.

На пример:

феат: Додајте ГитХуб као ОАутх провајдера
Интегришите ГитХуб као ОАутх добављача да бисте омогућили беспрекорно 
аутентификацију са ГитХуб налозима.
– Имплементирајте ток ОАутх аутентикације помоћу ГитХуб АПИ-ја
- Конфигуришите неопходне крајње тачке и подешавања за ГитХуб аутентификацију
- Ажурирајте кориснички интерфејс да бисте укључили опцију пријављивања на ГитХуб
Решава: #123
Погледајте такође: #456, #789

Подножје упућује на повезано питање #123 и помиње друга сродна питања #456 и #789 за додатни контекст.

Додавање поруке за урезивање

Можете писати поруке за урезивање користећи -м заставицу праћену поруком урезивања у наводницима (опционо, али препоручљиво).

Тхе -м заставица је идеална за кратке поруке урезивања, обично укључујући тип и опис.

На пример:

гит цоммит -м "задатак: Промени линтер у ЕСлинт"

Међутим, када ваша порука урезивања захтева више детаља, као што су тело и подножје, било би вам боље да урезивање напишете у уређивачу текста или ИДЕ.

Алтернативно, можете писати дуге поруке урезивања у текстуалној датотеци и користити --филе заставицу да бисте навели поруке урезивања као садржај текстуалне датотеке.

На пример:

гит цоммит --филе цоммит_мессаге.ткт

Када покренете горњу команду, гит ће користити садржај датотеке као поруку за урезивање.

Такође можете рећи гит-у да отвори ваш подразумевани уређивач да напише дужу поруку. Ако имате постављену променљиву окружења ГИТ_ЕДИТОР или ЕДИТОР, гит ће отворити тај програм када покренете голу гит цоммит команда.

Зашто би требало да пишете добре поруке о обавези

Писање добрих порука о обавези је кључно за ефикасну сарадњу и одржавање кода. Јасне и описне поруке помажу у разумевању, отклањању грешака и прегледима кода. Они чак могу допринети пројектној документацији или белешкама о издању.

Омогућавају дељење знања, несметано укључивање и подршку за контролу верзија. Давање приоритета квалитетним порукама урезивања побољшава развојне процесе и осигурава могућност одржавања базе кода.