Участие в работе с графическими инструментами — MRTK3

Обновление пакета

  1. Разветвление репозитория и создание ветви. Рекомендуется user/username/featureименование ветвей.
  2. Клонируйте и откройте GraphicsToolsUnityProject пример проекта в Unity.
  3. Внесите необходимые изменения. По умолчанию все изменения в пакете MRTK Graphics Tools будут опубликованы в пакете средств графики. (Если вы хотите обновить примеры, см. следующий раздел.)
  4. Отправьте ветвь в вилку и создайте запрос на вытягивание. Добавьте описание изменений в запрос на вытягивание. Изображения и GIF-изображения всегда ценятся.

Обновление примеров пакетов

Примеры существуют в подпапке Samples~ , как описано в примерах рекомендаций Unity. Символ ~ не позволяет импортировать папку Samples~ в Unity. Это идеальный вариант для добавления пакета через диспетчер пакетов. Но не при обновлении примеров в пакете.

Если вы хотите внести изменения в примеры, необходимо внести временное локальное изменение в структуру каталогов проекта Unity.

  1. Откройте приложение GraphicsToolsUnityProject в Unity . По умолчанию папка Samples не отображается в пакете MRTK Graphics Tools. Чтобы отобразить примеры, в строке меню "Файл" выберите Окно > Graphics Tools > Показать примеры.
  2. Внесите необходимые изменения в примеры.
  3. Важно! По завершении и перед фиксацией изменений не забудьте скрыть примеры. В строке меню "Файл" выберите пункт "Работа с графическими инструментами > окна>".

Совет

Не удалось вызвать пункт меню "Инструменты графики > окна>", чтобы скрыть пункт меню "Образцы" после редактирования примеров приведет к изменению git, думая, что все примеры файлов были изменены. После скрытия примеров фактические изменения файлов должны быть очевидны в Git.

Обновление документации

Справочная документация по API

Для комментариев к документации используйте рекомендуемый встроенный стиль ниже:

/// <summary>
/// Class <c>Point</c> models a point in a two-dimensional plane.
/// </summary>
public class Point
{
    /// <summary>
    /// Method <c>Draw</c> renders the point.
    /// </summary>
    void Draw() {...}
}

Основная документация

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

Совет

Статьи, связанные с графическими инструментами, можно найти в этой папке mixed-reality/mrtk-unity/mrtk3-graphicstools/

Начните с этих рекомендаций по участию в документации Майкрософт и руководству по участию в Смешанная реальность документации разработчика.