Упражнение. Создание вашего первого запроса на включение внесенных изменений

  • 6 мин

Вы узнали, как создать запрос на включение внесенных изменений (PR), когда есть рекомендации — в шаблоне запроса на включение внесенных изменений или в файле CONTRIBUTING. Но что делать, если проект еще не содержит рекомендации и документацию по соглашениям?

Опишите свои изменения

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

  • Строка темы сообщения фиксации Git должна завершить следующее предложение:
    • При применении эта фиксация <your subject line here>.
  • Включите краткое описание изменения, используя повелительное наклонение в настоящем времени. Например, используйте добавить не добавленные или добавляет.
  • Ограничьте строку темы до 50 символов.
  • Начните с заглавной буквы и не заканчивайте точкой (.).
  • Вы можете использовать эмодзи или @mention других пользователей GitHub в строке темы, но помните, что не все проекты разрешают или поддерживают это.

Для текста сообщения и запроса на включения изменений продолжайте использовать настоящее время. Обязательно включите причины для изменения. Сравните ваше изменение с предыдущим поведением. Используйте пространство в вашем распоряжении, чтобы объяснить, что и зачем, а не как.

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

Добавьте степень детализации

Прежде чем отправлять запрос на включение изменений, просмотрите боковую панель, чтобы узнать о способах завершения запроса на включение внесенных изменений. Если вы знакомы со структурой команды проекта, выберите Рецензенты и (или) Исполнители. Добавьте Метки при наличии рекомендаций по их использованию, например в файле CONTRIBUTING.md. Вы можете использовать метки в качестве визуальной подсказки того, что вы пытаетесь выполнить. Автор-разработчик может также добавить метку (или несколько меток).

Подсказка

Если в репозитории есть файл CONTRIBUTING.md или шаблон PR, следуйте инструкциям при заполнении запроса на вытягивание.

Вот некоторые из меток, которые мы используем в репозитории для этого модуля изучения:

  • Ошибка (красный): что-то не работает.
  • Документация (синий): улучшения или дополнения в документации.
  • Дубликат (серый): эта проблема или запрос на вытягивание уже существуют.
  • Улучшение (сине-зеленый): новая функция или запрос.

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

  • Нет подписки: получение уведомлений только при участии или @mentioned.
  • Подписка: получение всех уведомлений для этого запроса на вытягивание.
  • Настраиваемый: получение уведомлений только о выбранных событиях.

Упражнения

Использование ветвления и клонирования проекта Первый вклад и отправка запроса на включение изменений. Целью проекта "Первый вклад" является "руководство для начинающих по созданию первого вклада". Проект содержит руководство как для командной строки, так и для нескольких графических пользовательских интерфейсов (GUI). Проект также поддерживает несколько языков. Обязательно проверьте папку Translations.

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

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