Pull Request¶
Описание¶
Краткое изложение Предоставьте краткое изложение изменений в этом pull request.
Связанные задачи Исправляет #(номер задачи) Закрывает #(номер задачи) Относится к #(номер задачи)
Тип изменения¶
Категория изменения - [ ] Исправление ошибки (некритическое изменение, которое исправляет проблему) - [ ] Новая функция (некритическое изменение, которое добавляет функциональность) - [ ] Критическое изменение (исправление или функция, которая приведет к тому, что существующая функциональность не будет работать как ожидается) - [ ] Обновление документации - [ ] Улучшение производительности - [ ] Рефакторинг кода (без функциональных изменений) - [ ] Улучшения тестов - [ ] Улучшения сборки/CI - [ ] Другое: ___________
Область изменений - [ ] Изменения UI/UX - [ ] Изменения Backend/Service - [ ] Изменения базы данных - [ ] Изменения API - [ ] Изменения конфигурации - [ ] Обновлены зависимости
Детали реализации¶
Что было изменено? Предоставьте подробное описание внесенных изменений:
Почему это было изменено? Объясните обоснование изменений:
Как это было реализовано? Опишите использованный технический подход:
Тестирование¶
Покрытие тестами - [ ] Добавлены/обновлены модульные тесты - [ ] Добавлены/обновлены тесты виджетов - [ ] Добавлены/обновлены интеграционные тесты - [ ] Выполнено ручное тестирование - [ ] Тесты не нужны (объясните почему)
Выполненное тестирование Опишите тестирование, которое вы выполнили для проверки ваших изменений:
Результаты тестов - [ ] Все существующие тесты проходят - [ ] Новые тесты проходят - [ ] Ручное тестирование успешно - [ ] Тестирование производительности завершено (если применимо)
Тестовые окружения - [ ] Android (версия: _______) - [ ] iOS (версия: _______) - [ ] Web (браузер: _______) - [ ] Desktop (платформа: _______)
Качество кода¶
Чек-лист рецензирования кода - [ ] Код следует руководящим принципам стиля проекта - [ ] Выполнена самопроверка кода - [ ] Код хорошо прокомментирован, особенно в трудных для понимания областях - [ ] Не осталось отладочного кода или console logs - [ ] Нет неиспользуемых импортов или переменных - [ ] Обработка ошибок соответствующая - [ ] Управление ресурсами (освобождение) обрабатывается правильно
Соответствие архитектуре - [ ] Следует паттерну MVVM (если применимо) - [ ] Соответствующе использует внедрение зависимостей - [ ] Реализует паттерн repository (если применимо) - [ ] Следует установленным паттернам сервисного слоя - [ ] Поддерживает разделение ответственности
Документация¶
Обновления документации - [ ] Добавлены/обновлены комментарии кода - [ ] Обновлена документация API - [ ] Обновлена пользовательская документация - [ ] Обновлена документация разработчика - [ ] Обновлен README (при необходимости) - [ ] Обновлен CHANGELOG - [ ] Изменения документации не нужны
Чек-лист документации - [ ] Все публичные API документированы - [ ] Сложные алгоритмы объяснены - [ ] Предоставлены примеры использования (если применимо) - [ ] Предоставлено руководство по миграции (для критических изменений)
Критические изменения¶
Есть ли критические изменения? - [ ] Нет критических изменений - [ ] Да, критические изменения (опишите ниже)
Детали критических изменений Если да, опишите критические изменения и путь миграции:
Обратная совместимость - [ ] Полностью обратно совместимо - [ ] Устаревший старый API (с временными рамками миграции) - [ ] Критическое изменение с руководством по миграции - [ ] Критическое изменение без пути миграции (обоснуйте)
Влияние на производительность¶
Соображения производительности - [ ] Нет влияния на производительность - [ ] Производительность улучшена - [ ] Влияние на производительность оценено и приемлемо - [ ] Тестирование производительности завершено
Детали производительности Если есть последствия для производительности, предоставьте детали:
Использование памяти - [ ] Нет влияния на память - [ ] Использование памяти оптимизировано - [ ] Использование памяти увеличено (обосновано) - [ ] Утечки памяти проверены и устранены
Соображения безопасности¶
Рецензирование безопасности - [ ] Нет последствий для безопасности - [ ] Рецензирование безопасности завершено - [ ] Валидация входов реализована - [ ] Аутентификация/авторизация обрабатывается правильно - [ ] Чувствительные данные обрабатываются соответствующе
Чек-лист безопасности - [ ] Нет захардкоженных секретов или учетных данных - [ ] Пользовательский ввод правильно валидируется - [ ] Предотвращение SQL-инъекций (если применимо) - [ ] Предотвращение XSS (если применимо) - [ ] Правильная обработка ошибок (не утекает чувствительная информация)
Доступность¶
Соответствие доступности - [ ] Нет влияния на доступность - [ ] Внесены улучшения доступности - [ ] Совместимость с программой чтения с экрана проверена - [ ] Навигация с клавиатуры протестирована - [ ] Требования к цветовому контрасту соблюдены - [ ] Поддержка масштабирования шрифтов сохранена
Локализация¶
Интернационализация - [ ] Нет изменений текста - [ ] Весь пользовательский текст локализован - [ ] Ключи переводов добавлены в .arb файлы - [ ] Поддержка RTL макета сохранена (если применимо) - [ ] Форматирование даты/времени учитывает локаль
Скриншоты/Видео¶
Визуальные изменения Если ваши изменения включают модификации UI, пожалуйста, включите скриншоты или видео:
До: [Скриншот/видео текущего состояния]
После: [Скриншот/видео нового состояния]
Мобильная отзывчивость Если применимо, покажите, как изменения выглядят на разных размерах экрана.
Заметки о развертывании¶
Требования к развертыванию - [ ] Нет особых требований к развертыванию - [ ] Требуется миграция базы данных - [ ] Требуются изменения конфигурации - [ ] Требуется настройка стороннего сервиса - [ ] Обновлены переменные окружения
План отката Опишите, как откатить эти изменения при необходимости:
Дополнительный контекст¶
Связанная работа Свяжите любые связанные pull requests, задачи или обсуждения:
Будущая работа Опишите любую последующую работу, которую следует выполнить:
Известные ограничения Перечислите любые известные ограничения или технический долг, введенный:
Заметки для рецензентов¶
Области фокуса рецензирования Пожалуйста, обратите особое внимание на: - [ ] Корректность алгоритма - [ ] Обработка ошибок - [ ] Последствия для производительности - [ ] Соображения безопасности - [ ] Пользовательский опыт - [ ] Поддерживаемость кода - [ ] Покрытие тестами - [ ] Полнота документации
Вопросы для рецензентов Перечислите любые конкретные вопросы, которые у вас есть для рецензентов:
Чек-лист¶
Чек-лист перед подачей - [ ] Я выполнил самопроверку моего кода - [ ] Я прокомментировал мой код, особенно в трудных для понимания областях - [ ] Я внес соответствующие изменения в документацию - [ ] Мои изменения не генерируют новых предупреждений - [ ] Я добавил тесты, которые доказывают, что мое исправление эффективно или что моя функция работает - [ ] Новые и существующие модульные тесты проходят локально с моими изменениями - [ ] Любые зависимые изменения были слиты и опубликованы
Чек-лист подачи - [ ] Заголовок PR следует формату conventional commit - [ ] Описание PR полное и точное - [ ] Все обязательные разделы заполнены - [ ] Скриншоты/видео включены для изменений UI - [ ] Критические изменения четко документированы - [ ] Связанные задачи привязаны
Дополнительные заметки Добавьте любой другой контекст или заметки для рецензентов здесь.