Руководство по отправке сообщений

Сообщения о фиксации

Понятные сообщения о коммитах упрощают проверку запросов на извлечение и создание заметок о выпуске. Проект Blockly использует для этого стандартные коммиты .

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

<type>: <description>

[optional body]

[optional footer(s)]

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

Тип

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

  • chore : Для коммитов, которые выполняют рутинные/автоматизированные задачи, такие как обновление зависимостей.

  • deprecate : Для коммитов, которые делают функциональность устаревшей.

  • feat : Для коммитов, которые добавляют новые функциональные возможности в Blockly.

  • fix : Для коммитов, исправляющих ошибки/баги в Blockly.

  • release : Для коммитов, связанных с выпуском новой версии.

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

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

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

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

Описание

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

Тело

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

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

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

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

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

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

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