Няколко съвета за по-добри commit-и

git

Няколко съвета за по-добри commit-и

Вероятно вече сте правили безброй commit-и (ех, тази хубава българска дума). Понякога оставяте подробни съобщения, а понякога, не. С колеги положението е още по-лошо. Няма стандарт за съобщенията и всеки пише (ако е в настроение) съобщения по собствен “стандарт”. Съобщенията са напълно неконсистентни и трудни за търсене.

Време е да кажем “СТИГА”! В тази публикация ще Ви представя няколко добри практики при писането на commit коментари, за чието следване ще са Ви благодарни много хора (например колегите и “Вие след шест месеца”).

Лично аз разделям съобщенията си на 3 основни секции:

Тема

  • Кратко описание на решението.
  • Дръжте първия ред кратък - не повече от 50 символа.
  • Напишете с няколко думи какво сте променили. Проблема вече е описан в заданието.
  • Ползвайте сегашно време с повелителна форма на глаголите.
  • Не се плашете да поставяте флагове, които да дадат повече информация за промяната.

Тяло

  • Подробно описание на решението и/или други коментари.
  • Дръжте редовете не по-дълги от 80 символа.
  • Допълнителна информация
  • Въведете ID-то на issue-то, по което работите.
  • Възползвайте се от възможността да затворите автоматично ticket–а.

До тук добре, но за да накараме колегите да ползват единен стандарт, трябва да направим шаблон, по който всички да се водят. Моят шаблон, можете да видите в GitHub, а за да създадете собствен, изпълнете три прости стъпки:

  1. Създайте файл с име .gitmessage в home директорията си (C:\Users\<username> за Windows).
  2. Напишете текста на шаблона.
  3. Отворете .gitconfig файла си (~/.gitconfig за Linux и C:\Users\<username>\.gitconfig за Windows) и добавете:
1
2
[commit]
template = ~/.gitmessage

За да гарантирате ползването на шаблона, забранете на всички да commit-ват с -m и просто пишете git commit.

A Вие какви практики ползвате за да подобрите вашата работа с git?