Правило 50/72 — это общепринятая передовая практика форматирования сообщений коммитов в Git. Это немаловажно и для других систем контроля версий, так как абсолютно не привязано к Git. Изначально он был «придуман» и продвигался командой Linux Kernel, а позже завоевал всеобщую популярность.

Низкий стандарт приводит к невозможности отслеживания

Краткие, простые сообщения могут сэкономить вам массу времени, если вам нужно углубиться в историю проекта. Программисты, как правило, пишут односложные сообщения о коммите, которые мало что говорят о более позднем времени и делают отслеживание практически невозможным.

Вместо бесполезных однословных сообщений следуйте (или заставьте свою команду следовать) правилу Git 50/72 и поддерживайте четкую историю изменений кода.

В других случаях эти сообщения больше похожи на длинные описания, за которыми трудно уследить. Применение этого правила может помочь преодолеть эти проблемы и заставить писать хорошо отформатированные сообщения с правильным уровнем детализации.

Правила игры

Правило простое:

  • Резюме: не более 50 символов в первой строке
  • Затем пустая строка
  • Описание: произвольное количество длинных строк не более 72 символов, не более одной пустой строки между ними (эта часть не является обязательной. Для тривиальных коммитов вы можете вообще не захотеть писать какие-либо подробности.)

Почему 50 и почему 72?

Что ж, это определенно не случайные значения, а результат анализа кодовой базы ядра Linux на наличие идеальных значений. Кроме того, они очень хорошо работают в популярных инструментах разработки (подумайте о переносе текста в консоли и т. д.).

Лучшее приложение Jira для контроля коммитов

50/72 можно легко применить с помощью приложения Jira под названием Плагин политики фиксации. Идея состоит в том, что приложение требует, чтобы каждое сообщение фиксации, отправленное в репозиторий, соответствовало регулярному выражению, которое обеспечивает соблюдение вышеуказанных требований, в противном случае отправка отклоняется.

Чтобы создать политику фиксации, которая заставляет разработчиков соблюдать правило 50/72, просто сделайте следующее:

\S.{0,49}((\r\n|\r|\n)(\r\n|\r|\n).{1,72}((\r\n|\r|\n){1,2}.{1,72}(\r\n|\r|\n)?)*)*
  1. Наслаждайтесь красиво отформатированными сообщениями будущих коммитов!

Настройка плагина политики фиксации, чтобы помочь вашей команде следовать правилу Git 50/72, — это лишь один из способов, с помощью которого приложение может сделать ваш репозиторий в хорошем состоянии, а изменения кода — простыми для понимания рецензентом. Поскольку программное обеспечение сейчас проникает почти во все отрасли, в некоторых случаях также необходимо иметь проверенный журнал изменений кода. В регулируемых отраслях, таких как авиация или медицина, необходимо применять более строгие правила, поскольку действия, совершаемые или поддерживаемые вашим программным обеспечением, имеют далеко идущие последствия.

Будь то внутренняя проверка кода или выполнение требований властей, в наших общих интересах сделать так, чтобы изменения в исходном коде всегда можно было отследить в Git или любой другой системе контроля версий.

Создайте правило фиксации, подходящее вашей команде разработчиков!

Первоначально опубликовано на www.midori-global.com 2 апреля 2018 г.