80% программистов не пишут записи коммитов

Java Git

Оригинал: Miss Sister Taste (идентификатор публичной учетной записи WeChat: xjjdog), добро пожаловать, пожалуйста, сохраните источник для перепечатки. Любое воспроизведение, которое не содержит этого утверждения, является плагиатом.

Говорят, что 80% программистов не пишут записи коммитов. Это соотношение выше в нерегулируемых небольших компаниях, и вы видите, насколько это распространено.

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

Набор систем с открытым исходным кодом для учебных целей, добро пожаловать в звезду:GitHub.com/star hotel о, хорошо/неплохо…. Он включает в себя сложный бизнес ToB, бизнес с высокой степенью параллелизма в Интернете, приложение кэширования, DDD, руководство по микросервисам. Управляемый моделью, управляемый данными. Поймите путь эволюции крупномасштабных сервисов, навыки кодирования, изучите Linux и настройте производительность. Помощь Docker/k8s, мониторинг, сбор логов, изучение промежуточного ПО. Front-end технология, back-end практика и т.д. Основная техника:SpringBoot+JPA+Mybatis-plus+Antd+Vue3.

image-20210302104132788.png

Как будет отправлен журнал коммитов? Какие условности? На самом деле есть ответ. Для Java-программистов особенно радует. В IDEA есть очень полезный подключаемый модуль, который может помочь вам в отправке кода и создании командной спецификации. Далее я покажу вам, как его использовать.

Установить плагин

в ИДЕЕMarketplaceв поискахGit Commit Template, вы можете установить этот плагин. Плагин небольшой и может быть загружен быстро.

image-20210302104937753.png

При отправке кода из IDEA обычно. Мы нашли еще одну маленькую кнопку.

image-20210302105333440.png

После нажатия появится окно. Позволяет разработать шаблон отправки.

image-20210302105450485.png

Столько информации, прямо дух захватывает. Неудивительно, что программисты не любят писать записи коммитов.

Фактически, в интерфейсе установки плагина был объяснен формат записи отправки.

 <type>(<scope>): <subject>
 <BLANK LINE>
 <body>
 <BLANK LINE>
 <footer>

Из описания легко понять, что должно быть включено в запись коммита. Одним из самых типов, конечно же, является тип подчинения.

Отправить

Объясним в порядке отображения плагинов.

  • featФункцииfeatureзначение, также является наиболее часто используемым. Когда ваша функция изменится, вы можете использовать этот тип типа
  • fixКонечно, это относится к исправлению ошибок.
  • docsОбновленная документация или обновленные примечания
  • styleНастройка формата кода, например формат выполнения, изменение отображения вкладок и т. д.
  • refactorперестроить код. Относится к настройке структуры кода, например, к использованию некоторых шаблонов проектирования для реорганизации кода.
  • perfОптимизирована производительность проекта или модуля. Например, некоторые изменения параметров jvm, замена stringbuffer на stringbuilder и т.д.
  • testЭто просто, чтобы добавить код, связанный с модульным тестированием и автоматизацией.
  • buildНекоторые изменения, влияющие на компиляцию, такие как изменение плагина maven, добавление процесса npm и т. д.
  • ciИзменения в непрерывной интеграции. Теперь некоторые системы сборки любят использовать описание yml для функций ci. В случае таких изменений рекомендуется использовать ci
  • choreДругие изменения. Например, модификация комментариев или очистка файлов. Те, которые не затрагивают файлы src и тестового кода, можно разместить здесь
  • revertоткат части предыдущего кода

В дополнение к этим пресетам команды также могут добавлять новые в соответствии со своими потребностями.type. Например, для обработки онлайн-заказов на работу вы можете создатьticketтип.

сфера

Область действия — это значение области действия, в основном относится к влиянию кода. Объем не является обязательным, но команда может разработать его в соответствии со своим пониманием. Обычно его делят на два направления: техническое измерение и деловое измерение. Например, по технологии делят на:controller,dto,service,daoЖдать. Однако, поскольку представление функции будет включать в себя несколько областей (не любит очень детализированные представления), существует относительно мало случаев в соответствии с техническими параметрами.

Это также хороший выбор для разделения по бизнес-модулям. Такие какuser,orderЛегко увидеть, влияет ли это на пользовательский модуль или модуль заказа.

Если вы действительно не знаете, как его заполнить, оставьте его пустым.

разное

предмет

Это отражает способность обобщать и обобщать, не бегая. Одно предложение может описать, что такое основной коммит. тема также является строкой, отображаемой по умолчанию во многих инструментах управления git. Если писать стандартно, то журнал коммитов выглядит красиво и аккуратно.

тело

В основном заполняйте подробные записи об изменениях. Я вообще привык перечислять 1234, но если ваша тема написана очень хорошо, то текст можно прямо ослабить. Но если у вас есть достаточно времени, это хорошая привычка заполнять причины и следствия важных записей и предысторию потребностей.

Нижний колонтитул

Добавьте некоторые дополнительные хуки, такие как автоматическое закрытие заказа на работу jira после отправки записи (JIRA и gitlab могут быть связаны). Например, инициировать компиляцию какого-либо документа или другие действия.

Эта часть пользовательской линии также относительно сильна.

Skip CI

Наконец, есть опция пропуска CI. Общие инструменты ci можно настроить на автоматический запуск компиляции при отправке кода. Но вы можете сказать ему игнорировать эту фиксацию. Это может быть связано с тем, что вы заранее предвидели некоторые риски сборки или просто не хотите компилировать.

End

Наконец, глядя на типичный журнал коммитов, с поддержкой инструмента, наша ерунда тоже серьезна.

fix(order): 修复了1分钱买汽车的bug

商务反馈可以1分钱买汽车,目前已经卖出了100w量

Closes #2455

[skip ci]

На самом деле, суть подачиtypeиsubject. Один используется для указания его типа сдачи, а другой - для подведения итогов.Написав эти два пункта, можно запросто убить 80% программистов.

На этих основаниях изcommit log, Автоматически генерируетсяchange log, становится очень легко. С платформой непрерывной интеграции также можно автоматически генерировать записи об изменениях выпуска, поэтому руководство группы уделяет особое внимание спецификациям отправки git. Потому что это действительно полезно.

Набор систем с открытым исходным кодом для учебных целей, добро пожаловать в звезду:GitHub.com/star hotel о, хорошо/неплохо…. Он включает в себя сложный бизнес ToB, бизнес с высокой степенью параллелизма в Интернете, приложение кэширования, DDD, руководство по микросервисам. Управляемый моделью, управляемый данными. Поймите путь эволюции крупномасштабных сервисов, навыки кодирования, изучите Linux и настройте производительность. Помощь Docker/k8s, мониторинг, сбор логов, изучение промежуточного ПО. Front-end технология, back-end практика и т.д. Основная техника:SpringBoot+JPA+Mybatis-plus+Antd+Vue3.

Об авторе:Мисс сестра вкус(xjjdog), публичная учетная запись, которая не позволяет программистам идти в обход. Сосредоточьтесь на инфраструктуре и Linux. Десять лет архитектуры, десятки миллиардов ежедневного трафика, обсуждение с вами мира высокой параллелизма, дающие вам другой вкус. Мой личный WeChat xjjdog0, добро пожаловать в друзья для дальнейшего общения.​