Руководство по фиксации сообщения

Фиксировать сообщения

Четкие сообщения о фиксации облегчают просмотр запросов на включение и создание примечаний к выпуску. Для этого в проекте Blockly используются обычные коммиты .

Каждый коммит должен иметь формат:

<type>: <description>

[optional body]

[optional footer(s)]

Обратите внимание, что в основном репозитории Blockly есть линтер фиксации, который помогает обеспечить это. Если ваш запрос на включение содержит несколько коммитов, линтер проверит заголовок. Если у него есть один коммит, он проверит этот коммит. Лучше всего, если и ваши отдельные коммиты, и заголовок запроса на включение будут следовать этим рекомендациям.

Тип

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

работа по дому
Для коммитов, выполняющих рутинные/автоматизированные задачи, такие как обновление зависимостей.
осуждать
Для коммитов, которые устарели.
подвиг
Для коммитов, добавляющих новые функции в Blockly.
исправить
Для коммитов, исправляющих ошибки/ошибки в Blockly.
выпускать
Для коммитов, связанных с выпуском новой версии.

Критические изменения

Коммиты, вносящие критические изменения, должны добавлять ! после типа фиксации. Критические изменения — это изменения, которые могут нарушить работу разработчиков, использующих Blockly в своих приложениях, и заставят их выполнять дополнительную работу.

Например: fix!: return type of workspace.paste

Критические изменения могут иметь любой из указанных выше допустимых типов.

Описание

Описание не должно быть пустым и содержать не более 256 символов.

Тело

Тело не является обязательным. Если оно предусмотрено, между ним и описанием должна быть пустая строка. Его необходимо разбить на строки длиной не более 256 символов.

Обратите внимание, что обычно желательно помещать такого рода информацию в описание вашего запроса на включение в дополнение к/а не непосредственно в коммит.

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

Исправление нестандартных коммитов

Если вы не использовали обычные коммиты при внесении изменений, есть два варианта исправления сообщений в зависимости от того, сколько у вас коммитов:

  1. Если ваш запрос на включение содержит несколько коммитов, отредактируйте заголовок запроса на включение, чтобы он соответствовал требованиям. Когда запрос на включение будет объединен, другие ваши коммиты будут сжаты , и заголовок станет сообщением о коммите.

  2. Если ваш запрос на включение содержит один коммит, измените сообщение о коммите с помощью git commit --amend , а затем принудительно отправьте изменения в свою вилку Blockly. Это автоматически обновит все открытые запросы на включение, связанные с этой веткой. git push --force origin my-branch .