Правила проверки кода

Действия перед началом проверки запроса на вливание (PR)

• Убедитесь, что вы знакомы с пакетами, которые модифицируются запросом на вливание.

• Убедитесь, что у вас есть достаточно непрерывного времени для проверки запроса на вливание, используйте Yöntem: 300 строк кода на час для оценки.

• Убедитесь, что вы можете следить за обновлениями запроса на вливание в течение ближайших рабочих дней.

• Прочтите описание запроса на вливание, если его сложно понять, попросите программиста улучшить его.

• Для запроса на вливание исправления ошибок, если нет тестового случая, попросите программиста добавить тесты.

• Для запроса на вливание повышения производительности, если нет результатов бенчмарка, попросите программиста добавить результаты бенчмарка.

Проверочные пункты во время процесса проверки

• Может ли я понять цель каждого юнит-теста?

• Проходят ли юнит-тесты проверку того, что код выполняет намеченную функциональность?

• Обеспечивают ли юнит-тесты покрытие всех важных блоков кода и специальных случаев обработки ошибок?

• Можно ли переписать процедуры тестирования в таблицу-тесты?

• Соблюдает ли код стиль-руководство?

• Не повторяется ли один и тот же код более двух раз?

• Существуют ли комментарии, которые описывают цель кода?* Отмечены ли хаки, временные решения и работы по устранению проблем?

• Выполняет ли эта функция больше, чем указывает её название?

• Можно ли определить поведение этой функции по её названию?

• Существуют ли тесты, и являются ли они полными?

• Юнит-тесты охватывают ли все важные ветви кода?

• Можно ли извлечь тестовый код в таблицы-тесты?

Важные моменты при написании отзыва

• Будьте добры к программисту, а не к коду.

• Спрашивайте вопросы вместо того, чтобы делать заявления.

• Обращайтесь с людьми, знающими меньше вас, с уважением, почтением и терпением.

• Припомните, когда качество кода превышает ваши ожидания, делайте комплименты.

• Различие подхода программиста от вашего не обязательно является ошибкой.

• Ссылайтесь на документацию по стилю кода, когда это необходимо.

Важные моменты после отправки отзыва

• Часто проверяйте уведомления GitHub, чтобы следить за обновлениями запроса на вливание.

• Когда запрос на вливание был обновлён, начните новый круг проверки или дайте ему одобрение (LGTM).