Цели
Наш процесс проверки преследует несколько целей:
- Обеспечьте высокое качество кода как с точки зрения функциональности, так и с точки зрения читабельности.
- Выявляйте ошибки , потому что ошибки случаются.
- Поддерживайте единообразный стиль , чтобы можно было легко начать работу с любой частью кодовой базы.
Весь код, который входит в блочные образцы и ядро Blockly, проходит проверку, независимо от того, написан ли он участниками сообщества или членами команды Blockly.
Как рецензенты, мы стремимся работать с вами, чтобы внести ваши изменения как можно лучше. Мы просим вас, как участников, пообщаться с нами, чтобы ваши запросы на включение были проверены и объединены.
Процесс
Процесс PR-анализа проходит в несколько этапов:
Назначение
Когда поступает ваш запрос на включение, дежурный член команды Blockly назначает рецензента.
Рецензенты выбираются на основе опыта и для равномерного распределения рабочей нагрузки.
Назначение рецензента может занять несколько дней, а на получение отзыва — еще несколько дней. Не волнуйтесь, это нормально.
Обратная связь
На этапе обратной связи рецензент оставляет предложения по изменению вашего PR. Это могут быть простые вещи, которые помогут привести ваш код в соответствие с руководством по стилю Google JavaScript . Или это могут быть более серьезные вещи, например, просьба реорганизовать определения функций.
Рецензентам рекомендуется использовать проверки кода GitHub (а не оставлять отдельные комментарии), чтобы вы получали одно уведомление вместо нескольких.
Обсуждение
Фаза обсуждения — это ваш шанс ответить на отзыв. Возможно, один из комментариев к обзору был неясен: теперь у вас есть шанс попросить разъяснений. Или, может быть, ваш рецензент попросил внести изменения, но вы думаете, что это будет иметь последствия: теперь у вас есть шанс найти компромисс.
Редакция
На этапе пересмотра вы можете внести изменения в свой PR. Обычно эти изменения являются результатом того, что сказал ваш рецензент на этапе обратной связи.
После того как вы внесете правки, будет полезно отметить рецензента и попросить его еще раз просмотреть.
Повторение
После этапа доработки у вашего рецензента есть еще одна возможность оставить отзыв , и процесс начинается с самого начала.
Часто второй обзор прост и фокусируется на таких мелочах, как пунктуация и стиль кода. Но иногда второй обзор может оказаться весьма большим. Ваш первый рецензент может даже попросить кого-нибудь еще взглянуть на вас, чтобы получить свежий взгляд.
Слияние!
Фаза слияния – это ваш шанс отпраздновать это событие . Вы внесли изменение, обсудили и отредактировали его и, наконец, объединили! Это грандиозное достижение, которое многие люди никогда не начинают, не говоря уже о том, чтобы завершить!
Спасибо вам за всю вашу тяжелую работу, чтобы сделать Blockly лучше. И поздравляю!