Приглашаем вас отправлять сообщения об ошибках, проблемах и запросы на добавление функций в этот репозиторий.
У нас есть очень чёткие правила оформления сообщений о фиксации в 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 отменяемой фиксации.
Должен быть одним из следующих:
Для этого репозитория не существует предопределённых областей действия. Можно указать пользовательскую область для ясности.
Тема содержит краткое описание изменения:
Как и в теме, используйте повелительное наклонение, настоящее время: «изменение», а не «изменённое» или «изменения». Тело должно включать мотивацию для изменения и противопоставлять его предыдущему поведению.
В подписи должна содержаться информация о критических изменениях, а также ссылки на проблемы 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 )