Базовая спецификация журнала коммитов Git
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Формат объясняется следующим образом:
● type представляет собой тип отправки, например, исправление ошибки или добавление новой функции. Все типы типов следующие:
● feat: добавление функции
● fix: исправление ошибок
● docs: только изменение документов, таких как README, CHANGELOG, CONTRIBUTE и т. д.
● стиль: только изменение пробелов, форматирование отступов и т. д., не изменять логика кода
● рефакторинг: рефакторинг кода без добавления новых функций или исправления ошибок
● перфоманс: связан с оптимизацией, такой как повышение производительности и опыта
● тест: тестовые примеры, включая модульное тестирование, интеграционное тестирование и т. д.
● рутинная работа: изменение сборки процесс или Добавить зависимые библиотеки, инструменты и т. д
. вернуться: вернуться к предыдущей версии
Строка заголовка: в пределах 50 символов опишите основные изменения # # Основное содержание: текст более подробного описания, рекомендуется в пределах 72 символов. Информация, которая должна быть описана, включает в себя:
- Зачем нужно это изменение? Оно может быть использовано для исправления ошибки, добавления функции, повышения производительности, надежности, стабильности и т. д.
- Как он решил проблему? Подробно опишите действия по решению проблемы.
- Есть ли побочные эффекты, риски?
- Хвост: При необходимости вы можете добавить ссылку на адрес задачи или другие документы или закрыть задачу. скопировать код
Требование к формату:
Спецификация выпуска ветки и версии Git
● Основной принцип: мастер является защищенной ветвью, а модификация и отправка кода не выполняются непосредственно на мастере.
● При разработке ежедневных потребностей или проектов используйте ветку функций из основной ветки для разработки или ветку исправления для исправления ошибок. пометьте его для выпуска и, наконец, удалите ветку ветки разработки. Соглашение об именовании ветвей:
○ Правила именования версий ветвей: функция ветви времени выпуска ветви. Например: feature_20170401_fairy_flower
○ Типы ветвей включают в себя: функцию, исправление ошибок, рефакторинг трех типов, то есть разработку новых функций, исправление ошибок и реконструкцию кода. ○
Используйте год, месяц и день, чтобы назвать время, и введите 0, если оно менее 2 цифр
○ Используйте змеиный регистр для имени метода функции ветвления, то есть подчеркивание именования.
● Тег включает трехзначную версию с префиксом v. Например, v1.2.31. Соглашения об именах тегов:
○ Второй номер версии используется для разработки новых функций, а третий номер версии используется для исправления ошибок
○ Если основная базовая библиотека или средняя цена узла могут быть выпущены в большой версии, используйте версию в градациях серого. номер и добавьте суффикс после версии, разделив их тире. За альфа- или бета-версией следует количество раз, то есть количество альфа-версий:
■ v2.0.0-alpha-1
■ v2.0.0-belta-1
● Документы журнала изменений должны быть созданы до официального выпуска версии, а затем выпущен в Интернете.