Contributo a MRTK2

  • Articolo

Realtà mista Toolkit (MRTK) accoglie i contributi della community. Tutte le modifiche, grandi o piccole, devono rispettare gli standard di codifica MRTK. Assicurarsi di avere familiarità con questi problemi durante lo sviluppo per evitare ritardi durante la revisione della modifica.

In caso di domande, contattare il canale mixed-reality-toolkit su Slack. È possibile partecipare alla community slack tramite il mittente di inviti automatico.

Processi di invio

Sono disponibili diversi percorsi per consentire agli sviluppatori di contribuire a Realtà mista Toolkit, a partire dalla creazione di un nuovo problema.

Selezionare Tipo di problema

Da qui si file:

  • Report bug - Problema di funzionalità con uno dei componenti di Realtà mista Toolkit
  • Problema di documentazione - Problema con la documentazione di Realtà mista Toolkit
  • Richiesta di funzionalità - Proposta per una nuova funzionalità Realtà mista Toolkit

Proposta di richieste di funzionalità

Quando si richiede una nuova funzionalità Realtà mista Toolkit, è importante documentare il vantaggio/problema del cliente da risolvere. Dopo l'invio, una richiesta di funzionalità verrà esaminata e discussa in GitHub. Si consiglia di discutere apertamente e costruttivamente di ogni proposta di funzionalità per garantire che il lavoro sia vantaggioso per un ampio segmento di clienti.

Per evitare la necessità di rielaborare la funzionalità, è consigliabile che lo sviluppo della funzionalità non inizi durante la fase di revisione. Molte volte, il processo di revisione della community individua uno o più problemi che potrebbero richiedere modifiche significative nell'implementazione proposta.

Nota

Se si vuole lavorare su qualcosa che esiste già nel backlog, è possibile usare tale elemento di lavoro come proposta. Assicurarsi di commentare anche l'attività che notifica ai gestori che si sta lavorando per completarlo.

Processo di contributo

Attenersi alla procedura seguente per iniziare:

  1. Creare una copia tramite fork del repository. Fare clic sul pulsante "Fork" nella parte superiore destra della pagina e seguire il flusso.
  2. Creare un ramo nel fork (off del ramo principale ) per semplificare l'isolamento di eventuali modifiche fino a quando non è pronto per l'invio. Per le correzioni di bug durante un periodo di stabilizzazione della versione, cercare il ramo più recente prerelease/* . Le nuove funzionalità devono sempre passare a main.

Se si è nuovi al flusso di lavoro Git, vedere questa introduzione da GitHub.

Quando si aggiunge una correzione o una funzionalità di bug, seguire questa procedura:

  1. Implementare la correzione o la funzionalità di bug. Le istruzioni per la compilazione e la distribuzione di MRTK sono disponibili in Distribuzione nei dispositivi HoloLens e WMR. Ricordarsi di seguire le linee guida per la codifica.
  2. Se si aggiunge una funzionalità, aggiungere anche una scena di esempio che illustra la funzionalità.
  3. Se si aggiunge una funzionalità sperimentale, la scrittura di test e documentazione non è necessaria. Seguire invece le linee guida per le funzionalità sperimentali.
  4. Aggiungere test per verificare la correzione/funzionalità di bug. Le istruzioni per la scrittura e l'esecuzione di test sono in UnitTests.
  5. Verificare che il codice e le funzionalità siano documentati come descritto nelle linee guida per la documentazione.
  6. Assicurarsi che il codice funzioni come previsto in tutte le piattaforme. Per l'elenco delle piattaforme supportate, vedere le note sulla versione . Per i progetti UWP di Windows, il codice deve essere conforme a WACK. A tale scopo, generare una soluzione di Visual Studio, fare clic con il pulsante destro del mouse sul progetto; Negozio>Creare pacchetti app. Seguire le istruzioni ed eseguire i test WACK. Assicurarsi che abbiano avuto esito positivo.
  7. Seguire le istruzioni riportate in Richieste pull durante l'esecuzione di una richiesta pull.