Skip to content

Instantly share code, notes, and snippets.

@iredun

iredun/Semantic.md

Created Mar 18, 2021
Embed
What would you like to do?
Перевод для себя как писать коммиты по Semantic

Правила написания коммитов

Это вольный перевод, упрощенный местами Angular commit style

Каждое сообщение коммита состоит из заголовка, тела и колонтитула. Заголовок имеет специальный формат, который включает тип и тему:

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Заголовок является обязательным, остальное - необязательной (есть исключения).

Любая строка сообщения о фиксации не может быть длиннее 100 символов! Это позволяет легче читать сообщение на GitHub, а также в различных инструментах git.

Типы (<type>)

  • feat: Новая функция
  • fix: Исправление ошибки
  • docs: Изменения только в документации.
  • style: Изменения, не влияющие на смысл кода (пробелы, форматирование, отсутствие точек с запятой и т. д.).
  • refactor: Изменение кода, которое не исправляет ошибку и не добавляет функции.
  • perf: Изменение кода, улучшающее производительность.
  • test: Добавление недостающих или исправление существующих тестов.
  • chore: Изменения в процессе сборки или вспомогательных инструментах и библиотеках, таких как создание документации.

Заголовок (<subject>)

Тема содержит краткое описание изменения:

  • не делайте первую букву заглавной
  • нет ставьте точки (.) в конце

Тело сообщения (<body>)

Тело должно включать мотивацию к изменению и противопоставлять это предыдущему поведению.

Футер (<footer>)

Нижний колонтитул должен содержать любую информацию о критических изменениях, а также место для ссылки на проблемы GitHub, которые закрывает этот коммит. (Пулл запрос)

Критические изменения должны начинаться со слова BREAKING CHANGE: с пробела или двух символов новой строки. Затем для этого используется остальная часть сообщения фиксации. Подробное объяснение можно найти в этом документе.

Примеры коммитов

docs: поправлен README.md
feat: новая точка в API

Добавлена новая точка для создания пользователя:
- можно создать пользоватя простого
- обязателен номер телефона
fix: поправлена регистрацию юзера

Теперь не падает, если не передать пол
fix: поправлена регистрацию юзера

Теперь не падает если не передать пол
fix: поправлена регистрацию юзера

Переделана логика регистрации

BREAKING CHANGE: поменялся набор полей, внимательнее к документации
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment