Как пользоваться: Конструктор Conventional Commits
- Выберите тип изменения:
featдля новой функции,fixдля исправления ошибки или docs, refactor, perf, test, build, ci, chore, style или revert. - Добавьте необязательную область (часть кода, которую затрагивает изменение) и короткое описание в повелительном наклонении: «add», а не «added».
- Объясните в теле, что и зачем изменено. Отметьте Breaking change и опишите миграцию, если пользователям нужно что-то менять.
- Добавьте футеры вроде
Closes #123, исправьте всё, что отметили проверки, и скопируйте сообщение или командуgit commit.
Формат Conventional Commits
<type>[optional scope][!]: <description>
[optional body]
[optional footer(s)]| Тип | Для чего используется | Изменение версии |
|---|---|---|
feat | Новая функция | Minor (1.4.0 → 1.5.0) |
fix | Исправление ошибки | Patch (1.4.0 → 1.4.1) |
! или BREAKING CHANGE: | Изменение, к которому пользователям нужно адаптироваться | Major (1.4.0 → 2.0.0) |
| docs, style, refactor, perf, test, build, ci, chore, revert | Всё остальное | Нет (если не breaking) |
Инструменты вроде semantic-release, release-please и standard-version читают такие сообщения, чтобы выбрать следующую версию и автоматически написать changelog. commitlint проверяет их в CI или в git-хуке. Держите заголовок в пределах 72 символов, начинайте описание со строчной буквы с глагола в повелительном наклонении и не ставьте точку в конце. Сгенерировать changelog можно в генераторе changelog, а другие команды git — в генераторе git-команд.
Также ищут как: формат сообщений коммитов, генератор сообщений коммитов, семантические коммиты, commitlint, feat fix коммит, breaking change коммит.
Инструменты, которые хорошо сочетаются с Конструктор Conventional Commits
- Калькулятор semver — Всё о семантических версиях в одном месте: сравнивайте две версии, вычисляйте следующую major/minor/patch/prerelease и смотрите, какие версии допускает диапазон npm, например ^1.2.0 или ~2.3.
- Шпаргалка Git — Все команды Git, которые вы используете каждый день, и те, что нужны, когда что-то пошло не так, — с пояснением в одну строку.
- Генератор GitHub Actions — Выберите стек, триггеры и шаги, и вы получите закомментированный файл .github/workflows/ci.yml — установка, кеш, линтинг, тесты, сборка, матрица версий и необязательный деплой на GitHub Pages, Vercel или в реестр контейнеров.
- Генератор LICENSE — Добавьте подходящую лицензию open source в свой проект за несколько секунд.
Часто задаваемые вопросы
Что такое conventional commit?
Это сообщение коммита в формате type(scope): description, например fix(auth): handle expired tokens, которое инструменты могут прочитать, чтобы определить номер версии и собрать changelog.
Как пометить breaking change?
Добавьте ! после типа или области (feat(api)!: …) и футер BREAKING CHANGE:, в котором объясните, что изменилось. Отметьте Breaking change здесь, и оба элемента добавятся автоматически.
В чём разница между chore и refactor?
refactor меняет структуру кода без изменения поведения; chore — это обслуживание, которое не затрагивает поведение исходного кода, например обновление зависимостей или конфигурации инструментов.
Как написать многострочное сообщение коммита из командной строки?
Используйте по одному -m на каждый абзац: git commit -m "header" -m "body" -m "footer". Команда git здесь делает это за вас и экранирует кавычки.
Можно ли установить Конструктор Conventional Commits как веб-приложение и пользоваться им офлайн?
Да. Конструктор Conventional Commits — это веб-приложение (PWA), которое можно установить из браузера, без скачивания из магазина приложений. В Chrome или Edge (Windows, macOS, Linux, ChromeOS) или на Android нажмите вверху этой страницы «Установить приложение»; на iPhone и iPad используйте «Поделиться → На экран «Домой»», а в Safari 17+ на Mac — «Файл → Добавить в Dock». После этого приложение откроется в отдельном окне со своим значком, и так как оно полностью работает в браузере, оно продолжит работать офлайн. Firefox на компьютере не умеет устанавливать веб-приложения. Как работает установка.