Како учинити ваше поруке урезивања сјајним и обрадовати ваш тим

Поруке предавања су важно средство комуникације између чланова тима

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

Када анализирамо код или отклањамо грешке, сви имамо питања попут:

  • Зашто је ово ако је овде?
  • Ко је заборавио да ажурира грану?
  • Какав је утицај имала ова промена?
  • Како ова промена може икада поправити или побољшати код?

У том циљу, гит-крив нам омогућава да откријемо која је ревизија последња променила датотеку. Али само сазнање тога није довољно добро. Било би корисно да заиста прочитате поруку урезивања да бисте разумели шта се тамо заиста догодило.

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

Неке најбоље праксе

Дакле, ако је већина ваших Гит обавеза до сада створена са нечим сличним git commit -m "9000 — Bug fixes issue", следећи пут испробајте ове смернице:

Никада не користите о гит цоммит. -m sg& gt; / --message= gt; flag t

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

Први ред увек треба да има 50 знакова или мање, а иза њега треба да буде празан ред.

Напишите императивно време: „Поправи грешку“. [ Додај | Поправи | Уклони | Упдате | Рефацтор ] Доследна формулација олакшава менталну обраду листе урезивања.

Дужи опис са 72 знака.

Често је субјекат сам по себи довољан.Ако није, додајте празан ред (ово је важно) праћен једним или више пасуса тврдо умотаних у 72 знака.

Ти пасуси треба да објасне:

Зашто је ова промена неопходна?

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

Како се бави проблемом?

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

Које нежељене ефекте има ова промена?

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

# 50-character subject line## 72-character wrapped longer description. This should answer:## * Why was this change necessary?# * How does it address the problem?# * Are there any side effects?## Include a link to the ticket, if any.

Како си олакшати живот

Много је тога за запамтити, али можете поставити образац поруке урезивања помоћу commit.template

Конфигуришите Гит да користи датотеку шаблона (на пример, .gitmessage), а затим креирајте датотеку шаблона помоћу Вим:

git config --global commit.template ~/.gitmessagevim ~/.gitmessage

Када покренемо git commitбез -mзаставице поруке, уредник ће отворити наш корисни образац спреман за рад:

# [Add/Fix/Remove/Update/Refactor/Document] [summary]# Why is it necessary? (Bug fix, feature, improvements?)-# How does the change address the issue? -# What side effects does this change have?-# Include a link to the ticket, if any.

Коментарисане линије нису укључене у коначну поруку. Једноставно попуните празне редове текстом и тачкама испод упита.

Иссуе примаоца у ГитХуб и Битбуцкет како препознати кључне речи close, fixи resolveодмах затим у питању или повлачење броја захтева.

Мислим да би Линус био веома срећан да га никада више не користимо git commit -m "Fix bug"у јавном спремишту :)

Можете једноставно тражити у гит дневнику број издања, на пример, помоћу git log --grep=JIRA-1234

Такође можете да користите додатке као што су vim-fugitiveза вим или git lensза вс код за брзи приступ гит цоммит порукама.

Завршне мисли

Стварање чистих Гит обавеза говори пуно о вама и може бити примарни начин на који људи ступају у интеракцију с вама током пројеката.

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

Ваша будућност, и ви, и ваш тим, захваљиваћете вам на вашој промишљености и опширности када почну трчати git blameда виде зашто је тај услов ту.

Ако вам се свидео овај чланак, пљескајте, препоручите и делите.