Contribuindo para o MRTK2

Realidade Misturada Toolkit (MRTK) recebe contribuições da comunidade. Todas as alterações, grandes ou pequenas, precisam aderir aos padrões de codificação do MRTK. Verifique se você está familiarizado com eles durante o desenvolvimento para evitar atrasos quando a alteração está sendo revisada.

Se você tiver alguma dúvida, entre em contato com o canal do kit de ferramentas de realidade misturada no Slack. Você pode ingressar na comunidade do Slack por meio do remetente de convite automático.

Processos de envio

Fornecemos vários caminhos para permitir que os desenvolvedores contribuam para Realidade Misturada Toolkit, tudo começando com a criação de um novo Problema.

Selecionar Tipo de Problema

A partir daqui, você arquive:

  • Relatório de bugs – Problema de funcionalidade com um dos componentes do kit de ferramentas do Realidade Misturada
  • Problema de documentação – Problema com a documentação do kit de ferramentas do Realidade Misturada
  • Solicitação de recurso – Proposta de um novo recurso do Kit de Ferramentas do Realidade Misturada

Propondo solicitações de recursos

Ao solicitar um novo recurso Realidade Misturada Toolkit, é importante documentar o benefício/problema do cliente a ser resolvido. Depois de enviada, uma solicitação de recurso será revisada e discutida no GitHub. Incentivamos a discussão aberta e construtiva de cada proposta de recurso para garantir que o trabalho seja benéfico para um grande segmento de clientes.

Para evitar a necessidade de reformular o recurso, é recomendável que o desenvolvimento do recurso não comece durante a fase de revisão. Muitas vezes, o processo de revisão da comunidade descobre um ou mais problemas que podem exigir alterações significativas na implementação proposta.

Observação

Se você quiser trabalhar em algo que já existe em nossa lista de pendências, poderá usar esse item de trabalho como sua proposta. Lembre-se também de comentar sobre a tarefa notificando os mantenedores de que você está trabalhando para concluí-la.

Processo de contribuição

Siga estas etapas para começar:

  1. Crie fork do repositório. Clique no botão "Bifurcar" no canto superior direito da página e siga o fluxo.
  2. Crie um branch em sua bifurcação (fora do branch main) para facilitar o isolamento de todas as alterações até que esteja pronto para envio. Para correções de bugs durante um período de estabilização de versão, procure o branch mais recente prerelease/* . Os novos recursos sempre devem entrar em main.

Se você não estiver familiarizado com o fluxo de trabalho do Git, marcar esta introdução do GitHub.

Ao adicionar uma correção de bug ou recurso, siga estas etapas:

  1. Implemente a correção de bug ou o recurso. As instruções para criar e implantar o MRTK estão em Implantando em dispositivos HoloLens e WMR. Lembre-se de seguir as Diretrizes de Codificação.
  2. Se adicionar um recurso, adicione também uma cena de exemplo que demonstre o recurso.
  3. Se adicionar um recurso experimental, não será necessário escrever testes e documentação. Em vez disso, siga as diretrizes experimentais de recursos.
  4. Adicione testes para verificar a correção de bug/recurso. As instruções para escrever e executar testes estão em UnitTests.
  5. Verifique se o código e os recursos estão documentados conforme descrito nas Diretrizes de Documentação.
  6. Verifique se o código funciona conforme o esperado em todas as plataformas. Confira as Notas de versão para obter a lista de plataformas com suporte. Para projetos UWP do Windows, o código deve estar em conformidade com o WACK. Para fazer isso, gere uma solução do Visual Studio, clique com o botão direito do mouse no projeto; Loja>Criar Pacotes de Aplicativos. Siga os prompts e execute testes DO WACK. Certifique-se de que todos eles tenham êxito.
  7. Siga as instruções em Solicitações de Pull ao fazer uma solicitação de pull.