Предоставление отзыва на запрос на извлечение¶

Мы всегда рады отзывам от авторов, независимо от их уровня опыта.

Зачем проверять вклады?¶

Каждый представленный вклад должен быть проверен, независимо от того, был ли он представлен членом основной команды или новым участником. Каждый может что-то упустить. Процесс проверки существует для обеспечения дополнительной безопасности.

Цель процесса проверки — обеспечить, чтобы весь контент, включая код и документацию, был максимально лишен ошибок и прост в обслуживании. Любые ваши действия, способствующие достижению этой цели, будут приветствоваться. Это может быть что угодно, от исправления опечатки до поиска крайних случаев использования API, которые не были обнаружены. Вы можете предложить способы усовершенствования процедуры тестирования или структуры общей архитектуры изменений, чтобы их было проще поддерживать или расширять.

Могу я оставить отзыв?¶

Да! Вы можете предложить рецензию на любой открытый пул-реквест, который видите на BeeWare.

Как новичок, вы можете свободно просматривать любые запросы на изменение кода, даже если они были отправлены членом основной команды. Если вы новичок, вам может не хватать более широкого контекста проекта, но мы стремимся сделать кодовую базу доступной независимо от вашего уровня опыта. Если в коде есть что-то, что не имеет смысла, это может означать, что необходима дополнительная документация (либо в коде, либо в виде отдельной проектной документации).

Вклад в рассмотрение запроса на извлечение¶

Предоставление отзыва на запрос на извлечение

Все желающие могут ознакомиться с любыми вкладами в проект BeeWare. Перед тем, как приступить к работе, необходимо учесть некоторые важные моменты.

ПОДУМАЙТЕ, прежде чем оставлять отзыв¶

Прежде чем приступить к рецензированию, ПОДУМАЙТЕ. Как рецензенты, мы должны подумать, является ли ответ, который мы собираемся отправить:

Верно. Всегда стремитесь предоставлять точные предложения и информацию.
Полезно. Мы предоставляем рекомендации по улучшению представленной информации; эти рекомендации должны четко указывать источник проблемы или неучтенный вариант использования и, в идеале, предлагать путь к решению или удовлетворению запроса.
Вдохновляющий. От нас зависит, сможем ли мы вдохновить автора на то, чтобы он захотел внести запрошенные нами изменения.
Необходимо. Ожидается, что автор будет читать все, что мы публикуем; мы должны уважать его время и усилия, публикуя сообщения только в случае необходимости.
Доброжелательность. Существует множество способов выразить одну и ту же обратную связь; мы должны убедиться, что выбираем доброжелательные, поддерживающие и конструктивные слова.

Вполне возможно ДУМАТЬ и при этом давать эффективную оценку. Рассмотренные выше концепции не исключают указания на любые проблемы, которые вы обнаружили в PR. Участники не смогут улучшить свой вклад, если не будут знать о том, что требует улучшения. Важно помнить о том, как вы представляете эту обратную связь. Постарайтесь сделать свой отзыв обезличенным. Вместо «Вы допустили ошибку» можно сказать «Этот код можно улучшить». Оценивайте код, а не автора.

Важно помнить, что помимо указания на области, требующие улучшения, необходимо давать положительные отзывы. Если, например, изменения оказались особенно полезными, вы сделали что-то особенно умное или познакомились с API, о котором раньше не знали, сообщите об этом автору! Никогда не недооценивайте эффект от того, что вы отмечаете то, что кто-то сделал правильно или хорошо, в ситуации, когда все остальное, на что вы указали, — это проблемы, которые необходимо решить.

Предложения по обзору GitHub¶

Интерфейс GitHub для рецензирования имеет механизм предложений по изменениям, в котором вы можете указать точное изменение, которое вы предлагаете в качестве замены существующего контента. Имейте в виду, что до тех пор, пока они не будут приняты и зафиксированы, эти предлагаемые изменения не будут проходить предварительную проверку и проверку на линтинг. Поэтому эту функцию следует использовать для небольших изменений, поскольку чем больше предлагаемое изменение, тем больше вероятность возникновения проблем.