🤝 Соглашение об именовании коммитов

📌 Зачем это нужно?

Коммиты — это история проекта, и чем они понятнее, тем проще разбираться в коде. Единый формат коммитов помогает:

• 📖 Четко понимать, какие изменения были внесены.
• 🔍 Упрощать поиск нужных исправлений.
• 🤝 Улучшать взаимодействие между разработчиками.
• 📊 Автоматизировать анализ коммитов и формировать changelog.
• 🚀 Упрощать git blame, git log, git bisect и прочие инструменты.

Для унификации сообщений коммитов мы внедряем Conventional Commits.

---

🏗 Структура коммита

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

<тип>(<контекст>): <номер_задачи> | <краткое_описание>

<полное описание (необязательно)>

🔑 Разбор структуры:

• <тип> — Категория изменений (например, feat, fix, refactor).
• (<контекст>) — Подсистема/модуль, в котором произошли изменения.
• <номер_задачи> — Идентификатор задачи (если есть в таск-трекере).
• <краткое_описание> — Основная суть изменений.
• <полное описание> — Развернутое описание (по необходимости).

---

🚀 Типы коммитов

Тип	Описание
feat	✨ Добавление нового функционала
fix	🐛 Исправление багов
build	🏗 Изменения в процессе сборки проекта
chore	🔧 Обслуживающие изменения (настройки, конфиги)
ci	🤖 Изменения в CI/CD процессах
config	⚙ Изменения в конфигурационных файлах
docs	📖 Обновление документации
style	🎨 Изменения, не затрагивающие логику (отступы, форматирование)
refactor	🔄 Рефакторинг кода без изменения функциональности
perf	⚡ Оптимизация кода и улучшение производительности
test	🧪 Добавление или изменение тестов

---

📝 Примеры правильных коммитов:

feat(postbacks): 93393 | Добавлен функционал проверки постбеков

💡 Добавлен новый функционал проверки постбеков в системе.

fix(offers): 12345 | Не работала страница оффера у партнера

🐞 Исправлена ошибка, из-за которой страница оффера не загружалась.

build(frontend): Изменена сборка frontend

🏗 Изменен процесс сборки фронтенда для улучшения совместимости.

docs(postbacks): Документация раздела постбеки

📖 Добавлена документация для раздела "Постбеки".

refactor(orders): Улучшена обработка заказов

🔄 Оптимизирована логика обработки заказов, улучшена читаемость кода.

perf(pixel): Улучшение производительности пикселя

⚡ Снижена нагрузка и ускорена обработка пикселей в аналитике.

test(links): Автотесты модуля ссылок

🧪 Добавлены новые автотесты для проверки работы ссылок.

---

📌 Как писать названия пулл-реквестов?

Названия Pull Request'ов оформляем по той же схеме:

feat(auth): 11223 | Добавлена поддержка OAuth 2.0

📌 Это помогает сразу понять, о чем PR.

---

💡 Дополнительные рекомендации:

• ✅ Будь краток, но информативен.
• ✅ Избегай общих фраз типа "Исправлено" — указывай, что именно исправлено.
• ✅ Разделяй логические изменения — один коммит = одна задача.
• ✅ Не злоупотребляй fix — иногда исправление бага лучше оформить как refactor.
• ✅ Если в коммите правки по нескольким модулям, можно указать несколько контекстов:

  feat(auth, api): 11223 | Добавлена поддержка OAuth 2.0 в API
• ✅ Не забывай про changelog — грамотно оформленные коммиты помогают автоматизировать его генерацию.

---

🚀 Итог

Использование Conventional Commits делает историю изменений структурированной, понятной и удобной для всех участников команды. Следуя этому стандарту, мы облегчим поддержку кода, улучшим аналитику изменений и автоматизируем многие процессы! 💪