Поделиться через

Участие в MRTK2

  • Статья

Смешанная реальность Toolkit (MRTK) приветствует участие сообщества. Все изменения, большие или небольшие, должны соответствовать стандартам кодирования MRTK. Убедитесь, что вы знакомы с этими параметрами во время разработки, чтобы избежать задержек при проверке изменений.

Если у вас есть вопросы, свяжитесь с каналом mixed-reality-toolkit на Slack. Вступить в сообщество Slack можно с помощью автоматической рассылки приглашений.

Процессы отправки

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

Выбор типа проблемы

Здесь вы можете выполнить следующие действия:

  • Отчет об ошибках — проблема с функциональностью одного из компонентов набора средств Смешанная реальность
  • Проблема с документацией — проблема с документацией по Смешанная реальность Toolkit
  • Запрос функции — предложение по новой функции набора средств Смешанная реальность

Предложение запросов функций

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

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

Примечание

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

Процесс внесения вкладов

Чтобы приступить к работе, выполните эти действия.

  1. Создайте вилку репозитория. Нажмите кнопку "Fork" (Вилка) в правом верхнем углу страницы и следуйте за потоком.
  2. Создайте ветвь в вилке (вне ветви main), чтобы упростить изоляцию любых изменений до тех пор, пока они не будут готовы к отправке. Исправления ошибок во время периода стабилизации выпуска см. в разделе Последняя prerelease/* ветвь. Новые функции всегда должны идти в main.

Если вы не знакомы с рабочим процессом Git, проверка это введение из GitHub.

При добавлении исправления ошибки или функции выполните следующие действия.

  1. Реализуйте исправление ошибки или функцию. Инструкции по созданию и развертыванию MRTK см. в статье Развертывание на устройствах HoloLens и WMR. Не забудьте следовать рекомендациям по написанию кода.
  2. При добавлении функции также добавьте пример сцены, демонстрирующей эту функцию.
  3. При добавлении экспериментальной функции писать тесты и документацию не требуется. Вместо этого следуйте рекомендациям по экспериментальным функциям.
  4. Добавьте тесты для проверки исправления ошибки или функции. Инструкции по написанию и выполнению тестов см. в статье UnitTests.
  5. Убедитесь, что код и функции задокументированы, как описано в руководстве по документации.
  6. Убедитесь, что код работает должным образом на всех платформах. Список поддерживаемых платформ см. в заметках о выпуске . Для проектов Windows UWP код должен соответствовать WACK. Для этого создайте решение Visual Studio, щелкните правой кнопкой мыши проект; Магазин>Создание пакетов приложений. Следуйте инструкциям и запустите тесты WACK. Убедитесь, что все они успешно.
  7. Следуйте инструкциям в разделе Запросы на вытягивание при создании запроса на вытягивание.