Перейти к содержанию
100% локально

Конструктор conventional commit

Создавайте сообщения Conventional Commits из типа, области и описания, или проверьте существующие сообщения на ошибки.

Входные данные
Выходные данные

Конструктор conventional commit

Conventional Commits — это формат "type(scope): description", который ожидают генераторы changelog, semantic-release и commitlint. Этот инструмент создает его для вас: выберите тип, добавьте опциональную область, напишите описание, и он соберет заголовок — плюс тело и подвал со ссылками на тикеты, если вы их добавите. Переключитесь в режим проверки, чтобы сделать обратное: вставьте один или несколько существующих сообщений коммитов по одному на строку и посмотрите, что не так с каждым.

Список типов охватывает стандартный набор — feat, fix, docs, style, refactor, perf, test, build, ci, chore и revert. Переключатель критического изменения отмечает заголовок с "!" и, как только вы добавите описание, добавляет строку подвала "BREAKING CHANGE:", точно как ожидает спецификация. Опция максимальной длины заголовка обеспечивает бюджет символов, на который согласилась ваша команда (commitlint по умолчанию использует 72 символа); принуждение к строчной букве в начале и запрет на точку в конце — это два правила стиля, которые проверяют большинство линтеров коммитов по умолчанию, и оба можно отключить, если ваша команда их не использует.

В режиме проверки каждая строка рассматривается как один полный заголовок коммита, поэтому вывод "git log --oneline" проверяет целую партию за раз. Выберите, является ли выход отчетом — исходная строка, за которой следует то, что нужно исправить — или исправленное сообщение с автоматическим приведением к строчному регистру и удалением пунктуации, где это однозначно. Строка, которая вообще не соответствует форме type(scope): description, остается нетронутой, а не угадывается.

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

FAQ

Что такое Conventional Commit?
Сообщение коммита, написанное как "type(scope): description", опционально с телом и подвалом после. Инструменты, такие как commitlint, semantic-release и генераторы changelog, разбирают этот формат для определения версий и группировки заметок о выпуске.
Как работает режим проверки?
Вставьте одно сообщение коммита на строку — только заголовок, как строку из "git log --oneline". Каждая строка проверяется на соответствие списку типов, ограничению длины заголовка и вашим правилам прописных букв и точек, и сообщается отдельно.
Как отметить критическое изменение?
Включите "Критическое изменение" и добавьте описание. Заголовок получает "!" перед двоеточием и, как только описание будет не пусто, добавляется строка подвала "BREAKING CHANGE: …", в точности как ожидает спецификация Conventional Commits.
Могу ли я добавить ссылки на тикеты в подвал?
Да — введите их в поле подвала, например "Closes #123, refs JIRA-456". Это добавляется как отдельная строка после тела.
Моя история коммитов загружается куда-то?
Нет. Создание и проверка сообщений коммитов выполняется полностью в вашем браузере — ничто, что вы вводите или вставляете, не отправляется на сервер.