Оформление merge request
Заголовок
Формат аналогичен сообщению коммита, т.к. при слиянии изменений с MR сообщение merge-коммита берется из заголовка MR.
[WEB-...] Описание изменений
Заголовок MR должен отражать что меняется.
Описание
Чтобы шаблон появился при открытии merge request, достаточно добавить его в .gitlab/merge_request_templates/default.md в корне репозитория.
## Задача
:label: [WEB-<номер>](https://tracker.yandex.ru/WEB-...)
(удалите раздел, если MR не связан с задачей)
## Описание
Пожалуйста, опишите изменения, сделанные в этом MR:
- Какая задача решается: предпосылки и цель
- Что поменяется в коде и почему – обоснование выбора решения
- Если производится рефакторинг, подсветите зависимости и риски
- По возможности добавьте больше контекста для ревью кода и тестирования: ссылки, шаги для быстрой проверки результата и т.д.
## Тип изменений
- Не ломающие совместимость
- [ ] Устранение ошибки в коде
- [ ] Новая функциональность
- [ ] Улучшение текущего кода
- Ломающие совместимость
- [ ] Устранение ошибки в коде
- [ ] Новая функциональность
- [ ] Улучшение текущего кода
- Обновление документации
- [ ] README и др. внутренняя документация
- [ ] Комментарии в коде
- [ ] API
## Тестирование
- [ ] Я добавил(а) тесты, подтверждающие работу моего кода
- [ ] Все тесты проходят локально на моей машине
## Чеклист
- [ ] Мой MR имеет понятное описание и всю необходимую ревьюерам информацию
- [ ] Я добавил(а) необходимые лейблы к MR
- [ ] Я написал(а) комментарии в сложных и неявных местах
- [ ] Мой код соответствует соглашениям проекта по стилю и форматированию
- [ ] Мои изменения не создают новых предупреждений (warnings)
- [ ] Я сделал(а) самостоятельное ревью изменений
- [ ] Добавленные миграции корректно устанавливаются и удаляются
- [ ] После изменений я проверил(а) запуск проекта локально
- [ ] Я проверил(а) сообщение коммита, которое будет добавлено в историю мастера при вливании веткиРазделы
Тип изменений,ТестированиеиЧеклистмогут быть специфичными для каждого проекта.
Последнее обновление