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

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

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

У нас есть чёткие правила оформления сообщений о фиксации (commit messages) в Git. Это позволяет создавать более читаемые сообщения, которые легко отслеживать в истории проекта.

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

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

<тип>(<область>): <тема>
<пустая строка>
<тело>
<пустая строка>
<нижний колонтитул>

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

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

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

Пример 1:

feat: добавить файлы компоновки выпуска Fuji

fix(скрипт): исправить скрипт запуска, чтобы использовать правильные порты

Ранее службы устройства использовали неправильные номера портов. Этот коммит исправляет номера портов, чтобы использовать последние номера портов.

Закрывает: #123, #245, #992

Отмена фиксации

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

Тип

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

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

• commit 常用 type
• type 含义
• feat 新功能
• fix 修复 bug
• docs 修改文档
• style 代码格式修改
• refactor 重构（即不是新增功能，也不是修复 bug）
• perf 更改代码以提高性能
• test 增加测试
• build 构建过程或辅助工具的变动
• ci 修改项目持续集成流程
• chore 其他类型的提交
• revert 恢复上一次提交

Область

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

Тема

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

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

Тело

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

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

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

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