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

OSCHINA-MIRROR/mirrors-emq-x

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 7.3 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 01.12.2024 19:14 1da78c8

Вклад в проект

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

Рекомендации по оформлению сообщений о фиксации изменений

У нас есть очень чёткие правила оформления сообщений о фиксации в git. Это приводит к более читаемым сообщениям, за которыми легко следить, просматривая историю проекта.

Формат сообщения о фиксации

Каждое сообщение о фиксации состоит из заголовка, тела и подписи. Заголовок имеет специальный формат, который включает тип, область действия и тему:

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

Заголовок с типом является обязательным. Область действия заголовка необязательна. Для этого репозитория нет предопределённых областей. При желании для ясности можно использовать пользовательскую область.

Любая строка сообщения о фиксации не может быть длиннее 100 символов! Это позволяет сообщению легче читаться как на GitHub, так и в различных инструментах git.

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

Пример 1:

feat: add Fuji release compose files
fix(script): correct run script to use the right ports

Previously device services used wrong port numbers. This commit fixes the port numbers to use the latest port numbers.

Closes: #123, #245, #992

Отмена изменений

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

Тип

Должен быть одним из следующих:

  • feat: Новая функция для пользователя, а не новая функция для скрипта сборки.
  • fix: Исправление ошибки для пользователя, а не исправление скрипта сборки.
  • docs: Только изменения документации.
  • style: Форматирование, отсутствие точек с запятой и т. д.; без изменения производственного кода.
  • refactor: Рефакторинг производственного кода, например переименование переменной.
  • chore: Обновление задач grunt и т. п.; без изменения производственного кода.
  • perf: Изменение кода, улучшающее производительность.
  • test: Добавление недостающих тестов, рефакторинг тестов; без изменения производственного кода.
  • build: Изменения, влияющие на конвейер CI/CD или систему сборки или внешние зависимости (примеры областей: jenkins, makefile).
  • ci: Изменения, предоставленные DevOps для целей CI.
  • revert: Отменяет предыдущую фиксацию.

Область действия

Для этого репозитория не существует предопределённых областей действия. Можно указать пользовательскую область для ясности.

Тема

Тема содержит краткое описание изменения:

  • используйте повелительное наклонение, настоящее время: «изменить», а не «изменено» или «изменения».
  • не используйте заглавную букву.
  • не ставьте точку (.) в конце.

Тело

Как и в теме, используйте повелительное наклонение, настоящее время: «изменение», а не «изменённое» или «изменения». Тело должно включать мотивацию для изменения и противопоставлять его предыдущему поведению.

Подпись

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

Критические изменения должны начинаться со слова BREAKING CHANGE: с пробелом или двумя новыми строками. Остальная часть сообщения фиксации используется для этого.

Журнал изменений

Изменения, затрагивающие функциональность EMQX, должны описываться в отдельном файле Markdown в каталоге changes.

Шаблон имени файла: changes/(ce|ee)/(feat|perf|fix)-<PR-id>.en.md, где:

  • ce,ee: Указывает, затрагивает ли данное изменение общедоступную и корпоративную версию (ce), или только корпоративную версию (ee); для любого изменения нужен только один файл, поскольку корпоративная версия автоматически поглощает все изменения из общедоступной версии. Если вы сомневаетесь, вы можете обратиться к документации. Корпоративные функции имеют соответствующий баннер «Совет», см., например, здесь.
  • feat|perf|fix: Затрагивает ли изменение новую функциональность (feat), улучшение производительности (perf) или исправление ошибки (fix).
  • PR-id: Идентификатор запроса на вытягивание Github. Поскольку идентификатор запроса на вытягивание не может быть известен заранее.

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

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

1
https://api.gitlife.ru/oschina-mirror/mirrors-emq-x.git
git@api.gitlife.ru:oschina-mirror/mirrors-emq-x.git
oschina-mirror
mirrors-emq-x
mirrors-emq-x
master