Генератор сообщений коммитов

Детали коммита

0/72 символов

Краткое описание обязательно

Объясните что и почему, а не как

Предпросмотр

Заполните детали для генерации сообщения коммита...

Связанные инструменты

Генератор фейковых данныхГенерация тестовых данныхПросмотр MarkdownРедактор Markdown с живым просмотромПроверка различий кодаСравнение кода/текста бок о бок

Об этом инструменте

Спецификация Conventional Commits — это легковесная конвенция для сообщений коммитов. Она предоставляет простой набор правил для создания явной истории коммитов, что упрощает написание автоматизированных инструментов.

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

<type>(<scope>): <subject>

<body>

<footer>

Преимущества

  • Автоматически генерировать CHANGELOGs
  • Автоматически определять повышение семантической версии
  • Сообщать о характере изменений членам команды и заинтересованным сторонам
  • Запускать процессы сборки и публикации
  • Упростить людям участие, позволяя им исследовать более структурированную историю коммитов

Общие типы

✨
feat — A new feature
🐛
fix — A bug fix
📚
docs — Documentation only changes
💎
style — Code style changes (formatting, etc)
♻️
refactor — Code refactoring
✅
test — Adding or updating tests

Использование футера

Футер необязателен и содержит метаданные о коммите. Общие случаи использования включают:

Критические изменения: Используйте BREAKING CHANGE: для обозначения несовместимых изменений API. Это вызовет повышение мажорной версии в семантическом версионировании.
BREAKING CHANGE: Конечные точки API теперь требуют аутентификации
Пользователи должны обновить свои API-клиенты для включения токенов аутентификации
Ссылки на задачи: Связывайте коммиты с трекерами задач, используя ключевые слова, такие как Closes, Fixes или Resolves.
Closes #123
Fixes #456, #789
Соавторы и рецензенты: Указывайте вклад участников и рецензентов в коммите.
Co-authored-by: John Doe <john@example.com>
Reviewed-by: Jane Smith <jane@example.com>