Contribuindo com ferramentas gráficas – MRTK3

Artigo
07/12/2023

Como atualizar o pacote

Crie um fork do repositório e crie um branch. A nomenclatura de branch recomendada é user/username/feature.
Clone e abra o GraphicsToolsUnityProject projeto de exemplo no Unity.
Faça as alterações desejadas. Por padrão, todas as edições dentro do MRTK Graphics Tools pacote serão publicadas no pacote ferramentas gráficas. (Se você quiser atualizar os exemplos, consulte a seção abaixo.)
Efetue push do branch até a bifurcação e crie uma solicitação de pull. Adicione uma descrição das alterações à solicitação de pull. Imagens e gifs são sempre apreciados.

Atualizando os exemplos de pacote

Os exemplos existem na subpasta Samples~ conforme descrito pelas recomendações de exemplo do Unity. O caractere '~' impede que a pasta Exemplos~ seja importada pelo Unity. Isso é ideal ao incluir o pacote por meio do gerenciador de pacotes. Mas não quando você deseja atualizar os exemplos dentro do pacote.

Se você quiser contribuir com alterações nos exemplos, deverá fazer uma alteração local temporária na estrutura de diretórios do projeto do Unity.

Abra o GraphicsToolsUnityProject no Unity. A pasta Exemplos não ficará visível no pacote MRTK Graphics Tools por padrão. Para mostrar os exemplos, selecione Janela > Ferramentas de Gráfico > Mostrar Exemplos da barra de menus do arquivo.
Faça as alterações desejadas nos exemplos.
Importante: quando terminar e antes de confirmar suas alterações, lembre-se de ocultar os exemplos. Selecione Janela > Ferramentas > de Gráficos Ocultar Exemplos na barra de menus do arquivo.

Dica

A falha ao invocar o item de menu Ferramentas > de Gráficos de Janela > Ocultar Exemplos após a edição de exemplos resultará no git pensando que todos os arquivos de exemplo foram alterados. Depois que os exemplos estiverem ocultos, os arquivos reais alterados deverão ser aparentes no git.

Atualizando a documentação

Documentação da referência de API

Para comentários de documentação, use o estilo embutido recomendado abaixo:

/// <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() {...}
}

Documentação conceitual

Para atualizar documentos conceituais, acesse o repositório de documentos do Realidade Misturada.