Получение запроса на проверку pull-запроса

Ваш запрос на извлечение был отправлен и прошел CI. Теперь он готов к рассмотрению.

tl;dr — Процесс проверки

Краткая версия процесса проверки:

1. Ждите отзыва.
2. Отвечайте на отзывы.
3. Если требуются изменения:
4. Выполните запрошенные изменения.
5. Отправьте все запрошенные изменения.
6. Повторно запросите проверку, когда все запрошенные изменения будут внесены.
7. Повторяйте третий раздел до тех пор, пока не потребуются дальнейшие изменения.
8. Дождитесь, пока ваш пулл-реквест будет одобрен и объединен.

Поздравляем! Вы только что сделали взнос в BeeWare!

Я отправил свой запрос на добавление, что дальше?

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

Оцените ожидания

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

Если вы считаете, что ваш рецензент отклоняется от этих ожиданий, и вы не стесняетесь поднять этот вопрос самостоятельно в запросе на извлечение, вы можете это сделать. Если вы не чувствуете себя комфортно, обратитесь в команду по реагированию на нарушения кодекса поведения BeeWare. Мы рассмотрим ваше сообщение и свяжемся с вашим рецензентом. Результаты рассмотрения будут отражать сообщенные действия; незначительное нарушение может привести к обсуждению, а серьезное нарушение — к более серьезным последствиям.

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

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

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

Получение отзыва

Получение отзыва включает в себя три основных этапа:

1. Первые отзывы и вопросы.
2. Запросы на изменение.
3. Утверждение и слияние.

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

График и первые отзывы

Основная команда стремится обеспечить, чтобы каждый запрос на извлечение был рассмотрен в течение десяти рабочих дней. Однако в случае более сложных запросов или когда запрос на извлечение подается в период, когда часть команды находится в отпуске, этот срок может быть продлен.

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

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

Запросы на изменение

В большинстве случаев рецензент будет просить внести изменения в ваш пул-реквест. Это не обязательно отражает качество вашей работы, это просто часть процесса.

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

Выполнить запрошенные изменения

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

Пометка разговора как решенного

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

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

Отправить все запрошенные изменения

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

Толкайте, не принуждайте и не перебазируйте

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

Повторно запросить проверку

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

Утверждение и слияние запроса на извлечение

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