Участие в MRTK2

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

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

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

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

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

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

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

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

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

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

Примечание

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

Процесс вклада

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

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

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

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

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