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

Статья
07/12/2023

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

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

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

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

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

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

Совет

Если не вызвать пункт меню Window > Graphics Tools > Скрыть примеры после редактирования примеров, 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() {...}
}

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

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