Как да напишете правилни Git ангажименти съобщения

А git ангажира промените в хранилище.

Git ангажимент се изпълнява в хода на проект за запис на напредъка. След това този напредък се изтласква към отдалечен хранилище (като на github.com) чрез изпълнение на git push. Тези промени или напредък могат да означават всякакви допълнения, изтривания или актуализации на файловете, съхранявани в хранилището.

Преглед на правилния Git ангажимент

Кредит: Imgur

Най-бързият начин да напишете git ангажимент е да използвате командата git commit -m „Git počin съобщение тук“. Това обаче не се препоръчва за ангажименти, тъй като предоставя ограничено описание на променените. По същество git ангажимент трябва да обясни какво и защо е направена промяна.

Ето ръководството за писане на пълен git ангажимент.

  • Тема, която съдържа заглавието на git ангажимент. Това трябва да бъде ограничено до 50 знака и трябва да бъде отделено от останалата част от ангажимента с празен ред.
  • Обяснителен текст, обясняващ какво е променено и защо промяната е била необходима. Пишете в императивното настроение, напр. „Fix bug причинява прекъсване“, а не „Fixed bug причинява прекъсване“.

Вижте по-долу пример за изпълнение на горното.

Заглавие с главни букви, кратко (50 часа или по-малко) обобщение
По-подробен обяснителен текст, ако е необходимо. Увийте го до около 72
символи или така. В някои контексти първият ред се третира като
тема на имейл и останалата част от текста като орган. Празната
редът, отделящ обобщението от тялото, е критичен (освен ако не пропуснете
тялото изцяло); инструменти като rebase могат да се объркат, ако стартирате
две заедно.
Напишете съобщението си за ангажиране по наложително: „Fix bug“, а не „Fixed bug“
 или "Поправя грешка." Тази конвенция съвпада с генерираните съобщения за ангажиране
чрез команди като git merge и git revert.
След празните редове идват други параграфи.
- Точките на куршума също са наред
- Обикновено за куршума се използва тире или звездичка, последвано от едно интервал, с празни линии между тях, но условностите варират тук
- Използвайте висящ отстъп

Източник: Тим Поуп

Писане на правилен Git ангажимент

  • За да напишете git ангажимент, започнете с въвеждане на git commit във вашия терминал или команден ред, което извежда Vim интерфейс за въвеждане на съобщението за извършване.
  • Въведете темата на ангажимента си на първия ред. Не забравяйте да го държите кратко (не повече от 50 знака). Оставете празен ред след.
  • Напишете подробно описание на случилото се в извършената промяна. Използвайте множество абзаци и точки, за да дадете подробна разбивка. Не пишете всичко на един ред, вместо това увийте текст на 72 знака.
  • Натиснете Esc и след това въведете: wq, за да запазите и излезете.
Напишете вашето съобщение за ангажиране по наложително: „Fix bug“, а не „Fixed bug“ или „Fixes bug.“ Тази конвенция съвпада с съобщения за ангажиране, генерирани от команди като git merge и git revert.

Съобщението за ангажиране трябва да отговори на три основни въпроса;

  • Защо е необходима тази промяна?
  • Как този ангажимент решава проблема?
  • Какви ефекти има тази промяна?
Кредит: xkcd

Правилният, добре написан git дневник е важен показател за това колко добре обмислен проект.

Правилните съобщения за ангажиране ще улеснят разбирането защо е направена промяна в определен момент. С това поддръжниците на един проект лесно ще могат да правят промени десетилетия по-късно, защото разбират кода.

Честито кодиране!