6 простых советов, как ускорить проверку запросов на вытягивание

Запрос на вытягивание позволяет разработчикам добавлять новые функции или исправлять ошибки, не затрагивая основной код проекта или опыт пользователей. Они могут писать и тестировать обновления кода локально, не беспокоясь о нарушении всего продукта таким образом. Давайте разберемся, как создавать лучшие запросы на извлечение с помощью 6 простых указателей, которые заключаются в следующем:

1. Пусть компьютер сделает скучную часть

У вас мало времени и умственной выносливости, не тратьте их попусту. Проверка кода не должна сводиться к проверке стиля, тестов, сборок или неиспользуемых переменных (для некоторых это может показаться очевидным, но вы должны знать, что это не для всех). Есть 4 действия, которые вы должны автоматизировать, например, проверка:

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

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

2. Расскажите о своем намерении

Учтите, что любой член вашей команды может прочитать этот запрос на включение, даже если вы специально выберете своих рецензентов. Содержание и тон ваших первоначальных комментариев должны объективно информировать их о причинах, по которым вы открыли этот пулл-реквест, и о вашем решении.

It Help reviewers start their review by giving a lot of context in initial issue or code comments.  

3. Ограничьте влияние каждого запроса на включение в кодовую базу:

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

4. Ваш запрос на слияние должен говорить сам за себя

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

Часть вашего кода немного болезненна для понимания? Таким образом, вы должны были написать специальные комментарии в коде, но вы также можете написать некоторые комментарии для проверки кода до прибытия ваших рецензентов. Вы проложите путь к их пониманию!

5. Используйте шаблон запроса на слияние

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

6. Предоставьте всю необходимую информацию для тестирования кода

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