Contribuindo para o MRTK

a realidade mista Toolkit (MRTK) agradece as contribuições da comunidade. Todas as alterações são pequenas ou grandes, precisam aderir aos padrões de codificação MRTK, portanto, verifique se você está familiarizado com isso ao desenvolver para evitar atrasos quando a alteração está sendo revisada.

Se você tiver alguma dúvida, entre em contato com o canal Mixed-Realm-Toolkit na margem de atraso. Você pode ingressar na comunidade do Slack por meio do remetente de convite automático.

Processo de envio

fornecemos vários caminhos para permitir que os desenvolvedores contribuam para a realidade misturada Toolkit, tudo isso começando com a criação de um novo problema.

Select Issue Type

A partir daqui, você arquivo:

  • relatório de bugs -problema de funcionalidade com um dos componentes da realidade misturada Toolkit
  • problema de documentação -problema com a realidade misturada Toolkit documentação
  • solicitação de recurso -proposta para um novo recurso Toolkit de realidade misturada

Proposta de solicitações de recursos

ao solicitar uma nova realidade misturada Toolkit recurso, é importante documentar o benefício do cliente/problema a ser resolvido. Depois de enviado, uma solicitação de recurso será examinada e discutida em GitHub. Incentivamos a discussão aberta e construtivas de cada proposta de recurso para garantir que o trabalho seja benéfico para um grande segmento de clientes.

Para evitar a necessidade de retrabalhar o recurso, geralmente é 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ê deseja trabalhar em algo que já existe em nossa pendência, você pode usar esse item de trabalho como sua proposta. Lembre-se também de comentar a tarefa notificando os mantenedores de que você está trabalhando para concluí-la.

Processo de contribuição

Para começar, basta seguir estas etapas:

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

Se você for novo no fluxo de trabalho do git, Confira esta introdução do GitHub.

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

  1. Implemente a correção de bugs ou o recurso. As instruções para criação e implantação de MRTK estão em implantação 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 demonstra o recurso.
  3. Se estiver adicionando um recurso experimental, não será necessário escrever testes e documentação. Em vez disso, siga as diretrizes de recurso experimental.
  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. Consulte as notas de versão para obter a lista de plataformas com suporte. para Windows projetos UWP, o código deve ser compatível com WACK. para fazer isso, gere uma solução de Visual Studio, clique com o botão direito do mouse no projeto; Armazenar > Criar pacotes de aplicativos. Siga os prompts e execute os testes do WACK. Certifique-se de que todos tenham sucesso.
  7. Siga as instruções em solicitações pull ao fazer uma solicitação de pull.