Как мы ревьювим код
Введение
Добро пожаловать в руководство по код-ревью! Эта статья поможет тебе понять, как у нас проходит процесс проверки кода, какие правила действуют, и какие советы помогут сделать код-ревью более эффективным. Понимание этих аспектов важно для поддержания высокого качества кода и эффективной работы команды.
Правила
- Код-ревью считается пройденным: Чтобы код-ревью было признано завершенным, необходимо получить два аппрува от членов команды. Это гарантирует, что изменения были проверены с разных точек зрения и соответствуют нашим стандартам качества.
- Conventional Commits: Мы придерживаемся спецификации Conventional Commits, чтобы поддерживать чистую историю коммитов и автоматизировать процесс версионирования. Это помогает обеспечить единообразие и упрощает понимание изменений в проекте.
Советы
- Читай код внимательно: Проверь не только наличие ошибок, но и логику, стиль и соответствие требованиям. Убедись, что код понятен и легко поддерживается.
- Давай конструктивную обратную связь: Комментарии должны быть конкретными и полезными. Если замечаешь проблему, предложи способы её исправления.
- Не стесняйся задавать вопросы: Если что-то непонятно, лучше спросить, чем предполагать. Это поможет избежать недопонимания и улучшит качество кода.
- Проверяй соответствие требованиям: Убедись, что код соответствует задачам и требованиям, указанным в тикете.
Код-стайл
Мы придерживаемся определенного код-стайла, чтобы поддерживать единообразие и читаемость кода. Подробности можно найти в нашем руководстве по код-стайлу. Убедись, что твой код соответствует этим стандартам перед отправкой на ревью.
Авто-тесты
У нас настроены авто-тесты, которые автоматически запускаются при каждом коммите. Результаты тестов отправляются на Allure сервер, где их можно просмотреть для анализа. Это помогает выявить проблемы на ранних стадиях и гарантирует, что код работает корректно.
Авторы
melvspace Vadim Melnikov