Contribuir para o MRTK2

  • Artigo

Mixed Reality Toolkit (MRTK) saúda as contribuições da comunidade. Todas as alterações, grandes ou pequenas, têm de cumprir as normas de codificação do MRTK. Certifique-se de que está familiarizado com estes problemas durante o desenvolvimento para evitar atrasos quando a alteração está a ser revista.

Se tiver dúvidas, contacte o canal mixed-reality-toolkit no Slack. Pode aderir à comunidade slack através do remetente de convite automático.

Processos de submissão

Fornecemos vários caminhos para permitir que os programadores contribuam para Mixed Reality Toolkit, tudo começando por criar um novo Problema.

Selecionar Tipo de Problema

A partir daqui, arquive:

  • Relatório de erros – Problema de funcionalidade com um dos componentes do Mixed Reality Toolkit
  • Problema de documentação – Problema com a documentação do Mixed Reality Toolkit
  • Pedido de funcionalidade – Proposta para uma nova funcionalidade do Mixed Reality Toolkit

Propor pedidos de funcionalidades

Ao pedir uma nova funcionalidade Mixed Reality Toolkit, é importante documentar o benefício/problema do cliente a resolver. Uma vez submetido, um pedido de funcionalidade será revisto e discutido no GitHub. Incentivamos a discussão aberta e construtiva de cada proposta de funcionalidade para garantir que o trabalho é benéfico para um grande segmento de clientes.

Para evitar a necessidade de reformular a funcionalidade, recomenda-se que o desenvolvimento da funcionalidade não comece durante a fase de revisão. Muitas vezes, o processo de revisão da comunidade revela um ou mais problemas que podem exigir alterações significativas na implementação proposta.

Nota

Se quiser trabalhar em algo que já existe no nosso backlog, pode utilizar esse item de trabalho como proposta. Certifique-se de que também comenta a tarefa que notifica os responsáveis pela manutenção de que está a trabalhar para a concluir.

Processo de contribuição

Para começar, siga estes passos:

  1. Bifurque o repositório. Clique no botão "Fork" no canto superior direito da página e siga o fluxo.
  2. Crie um ramo no seu fork (fora do ramo principal ) para facilitar o isolamento de quaisquer alterações até estar pronto para submissão. Para correções de erros durante um período de estabilização de versão, procure o ramo mais recente prerelease/* . As novas funcionalidades devem sempre entrar em main.

Se não estiver familiarizado com o fluxo de trabalho do Git, veja esta introdução no GitHub.

Ao adicionar uma correção ou funcionalidade de erros, siga estes passos:

  1. Implemente a correção ou funcionalidade de erros. As instruções para criar e implementar o MRTK estão em Implementar em dispositivos HoloLens e WMR. Lembre-se de seguir as Diretrizes de Codificação.
  2. Se adicionar uma funcionalidade, adicione também uma cena de exemplo que demonstre a funcionalidade.
  3. Se adicionar uma funcionalidade experimental, não é necessário escrever testes e documentação. Em vez disso, siga as diretrizes de funcionalidades experimentais.
  4. Adicione testes para verificar a correção de erros/funcionalidade. As instruções para escrever e executar testes estão em UnitTests.
  5. Certifique-se de que o código e as funcionalidades estão documentados conforme descrito nas Diretrizes de Documentação.
  6. Certifique-se de que o código funciona conforme pretendido em todas as plataformas. Veja as Notas de versão da lista de plataformas suportadas. Para projetos do Windows UWP, o código tem de ser compatível com WACK. Para tal, gere uma solução do Visual Studio, clique com o botão direito do rato no projeto; Loja>Criar Pacotes de Aplicações. Siga as instruções e execute testes WACK. Certifique-se de que todos têm sucesso.
  7. Siga as instruções em Pedidos Pull ao fazer um pedido Pull.