Přispívání do MRTK

Tento Mixed Reality Toolkit (MRTK) vítá příspěvky od komunity. Všechny změny, které jsou malé nebo velké, musí dodržovat standardy kódování MRTK,proto se ujistěte, že je při vývoji znáte, abyste se vyhnuli zpožděním při jejich kontroly.

Pokud máte nějaké dotazy, obraťte se na kanál mixed-reality-toolkit na webu Slack. Ke komunitě Slack se můžete připojit prostřednictvím automatického odesílatele pozvánek.

Proces odeslání

Nabízíme několik způsobů, jak vývojářům umožnit přispívat do Mixed Reality Toolkit, a to vše od vytvoření nového problému.

Vyberte Typ problému.

Z tohoto souboru:

  • Zpráva o chybě – Problém s funkcemi jedné z Mixed Reality Toolkit komponent
  • Problém s dokumentací – Problém s Mixed Reality Toolkit dokumentace
  • Žádost o funkci – Návrh na novou Mixed Reality Toolkit funkce

Navrhování žádostí o funkce

Při žádosti o novou Mixed Reality Toolkit je důležité zdokumentovat výhody nebo problém zákazníka, který se má vyřešit. Po naslaní se žádost o funkci zhodnotí a prodiskutuje GitHub. Doporučujeme otevřít a konstruktivně prodiskutovat jednotlivé návrhy funkcí, abyste zajistili, že práce bude přínosná pro velký segment zákazníků.

Aby se zabránilo tomu, že je potřeba funkci přepracování, obecně se doporučuje, aby vývoj funkce nezačne ve fázi revize. Proces revize komunity v mnoha časech odhalí jeden nebo více problémů, které mohou vyžadovat významné změny v navrhované implementaci.

Poznámka

Pokud chcete pracovat na něčem, co už v backlogu existuje, můžete tuto pracovní položku použít jako svůj návrh. Nezapomeňte také přidat komentář k úkolu oznamující správci, že na jeho dokončení pracujete.

Proces přispívání

Pokud chcete začít, jednoduše postupujte podle těchto kroků:

  1. Fork úložiště. Klikněte na tlačítko Fork v pravém horním rohu stránky a postupujte podle toku.
  2. Vytvořte větev ve forku (mimo hlavní větev), abyste usnadnili izolaci všech změn, dokud nebudou připravené k odeslání. Pokud chcete opravy chyb během období stabilizace verze, vyhledejte nejnovější prerelease/* větev. Nové funkce by měly vždy přejít na main .

Pokud s pracovním postupem Gitu je pro vás novinka, podívejte se na tento úvod z Githubu.

Při přidávání opravy chyby nebo funkce postupujte takto:

  1. Implementujte opravu nebo funkci chyby. Pokyny k sestavení a nasazení MRTK najdete v tématu Nasazení do zařízení Hololens a WMR. Nezapomeňte postupovat podle pokynů pro kódování.
  2. Pokud přidáváte funkci, přidejte také příklad scény, která funkci předvede.
  3. Pokud přidáváte experimentální funkci, není psaní testů a dokumentace nutné. Místo toho postupujte podle pokynů k experimentálním funkcím.
  4. Přidejte testy pro ověření opravy chyb nebo funkce. Pokyny pro psaní a spouštění testů najdete v UnitTests.
  5. Ujistěte se, že jsou kód a funkce zdokumentované tak, jak je popsáno v pokynech k dokumentaci.
  6. Ujistěte se, že kód funguje tak, jak má, na všech platformách. Seznam podporovaných platforem najdete v poznámkách k verzi. Pro Windows UPW musí být kód kompatibilní se standardem WACK. Chcete-li to provést, vygenerování Visual Studio řešení, klikněte pravým tlačítkem na projekt. ÚložištěVytvořte balíčky aplikací. Postupujte podle pokynů a spusťte testy WACK. Ujistěte se, že jsou všechny úspěšné.
  7. Při vytváření žádosti o změnu postupujte podle pokynů v tématu Žádosti o změnu.