1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/pingcap-tidb

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
code_review_guide.md 3.8 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 08.06.2025 01:37 f02cfc7

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

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

  • Убедитесь, что вы знакомы с пакетами, которые изменяет PR.

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

  • Убедитесь, что вы можете следить за обновлениями PR в течение следующих нескольких рабочих дней.

  • Прочитайте описание PR, если оно не легко понимается, попросите разработчика улучшить его.

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

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

Проверки, которые следует провести во время процесса проверки

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

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

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

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

  • Соблюдает ли код стиль, описанный в руководстве?

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

  • Существуют ли комментарии, описывающие цель кода?

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

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

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

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

  • Могут ли тесты быть переписаны в табличные тесты?

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

  • Будьте добры к разработчику, а не к коду.

  • Ставьте вопросы, а не делайте утверждения.

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

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

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

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

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

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

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

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/pingcap-tidb.git
git@api.gitlife.ru:oschina-mirror/pingcap-tidb.git
oschina-mirror
pingcap-tidb
pingcap-tidb
master