1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/NoahV-NoahV

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
COMMIT.md 5.3 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 02.12.2024 10:56 c338017

1. Резюме

Информация о коммите должна проходить следующую проверку регулярным выражением:

/^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore)(\(.+\))?: .{1,50}/

2. Полный стандарт формата информации о коммите

Формат информации о коммите должен соответствовать следующему стандарту:

<type>(<scope>): <subject>
<пустая строка>
<body>
<пустая строка>
<footer>

Полный коммит включает в себя три части:

  • заголовок (формат первой строки <type>(<scope>): <subject>);
  • тело;
  • футер.

Заголовок обязателен, тело и футер — опциональны.

В заголовке содержится:

  • тип (тип коммита, подробнее см. 2.1);
  • scope (область влияния);
  • subject (информация о коммите).

Тип и subject обязательны, scope — опционален.

Для отмены изменений в коммите используется revert: в начале, после чего идёт информация об отменяемом коммите. В теле необходимо указать commit hash: This reverts commit <hash>.

revert:<type>(<scope>): <subject>
<пустая строка>
<body>
<пустая строка>
<footer>

2.1 Тип в заголовке может быть следующим:

Тип коммита Описание
feat Добавление новой функции
fix Исправление проблемы
polish Оптимизация определённой части функционала
docs Обновление документации
style Форматирование, изменение кода для соответствия стандартам оформления
refactor Рефакторинг определённой части функционала
perf Улучшение производительности
test Изменения, связанные с модульным тестированием
workflow Рабочий процесс, инфраструктура
ci Непрерывная интеграция
chore Другие изменения, не влияющие на код, например, обновление информации о спонсорах или авторах на страницах документации

2.2 Scope

Указывает область изменений, желательно максимально точно определить, что именно было изменено, например (component, core, dashboard, template, request), если затронуто несколько областей.

2.3 Subject

Тема должна содержать краткую информацию об изменениях, следуя следующим правилам:

  • Использовать настоящее время, например change, а не changed или changes.
  • Не использовать заглавную букву в первом слове.
  • Избегать точки в конце.
  • После двоеточия добавлять пробел.
  • По возможности избегать использования знаков препинания.

2.4 Body

Тело должно содержать информацию о контексте изменений и их различиях с предыдущей версией.

2.5 Footer

Футер содержит важную информацию о изменениях или ссылки на связанные задачи на GitHub.

  1. Связанные задачи на GitHub:
fix(workflow): handle project init error on linux for scaffold

close #28
  1. Важные изменения:
perf(core): imporve header render by removing 'logo' option 

BREAKING CHANGE: The 'logo' option has been removed from header conf.

3. Примеры

3.1 Добавление новой функциональности в компонент

feat(component): add nodata tip for nvtrend

3.2 Исправление ошибки в рабочем процессе

fix(workflow): handle project init error on linux for scaffold

3.3 Обновление документации

docs: fix link for logo

3.4 Отмена обновления компонента

revert: feat(component): add nodata tip for nvtrend

This reverts commit e80a92447717dc9cc9187a14e469a38c164a8600.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/NoahV-NoahV.git
git@api.gitlife.ru:oschina-mirror/NoahV-NoahV.git
oschina-mirror
NoahV-NoahV
NoahV-NoahV
master