Sdílet prostřednictvím

Přispívání do MRTK2

  • Článek

Mixed Reality Toolkit (MRTK) vítá příspěvky od komunity. Všechny změny, velké i malé, musí být v souladu s kódovacími standardy MRTK. Ujistěte se, že jste s těmito informacemi obeznámeni při vývoji, abyste se vyhnuli zpožděním při kontrole změny.

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

Procesy odeslání

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

Vyberte Typ problému.

Tady můžete zadat:

  • Zpráva o chybě – Problém s funkčností jedné z komponent sady Mixed Reality Toolkit
  • Problém s dokumentací – Problém s dokumentací k sadě Mixed Reality Toolkit
  • Žádost o funkci – Návrh nové funkce sady Mixed Reality Toolkit

Navrhování žádostí o funkce

Při žádosti o novou funkci Mixed Reality Toolkit je důležité zdokumentovat výhody a problémy pro zákazníky, které je třeba vyřešit. Po odeslání se žádost o funkci zkontroluje a probere na GitHubu. Doporučujeme otevřenou a konstruktivní diskuzi o každém návrhu funkce, abychom zajistili, že práce bude přínosná pro velký segment zákazníků.

Abyste nemuseli funkci přepracovávat, doporučuje se, aby se vývoj funkce nezačínaly během fáze kontroly. Proces komunitní kontroly často 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 našem backlogu existuje, můžete tuto pracovní položku použít jako svůj návrh. Nezapomeňte také okomentovat úkol s upozorněním, že pracujete na jeho dokončení.

Proces přispívání

Chcete-li začít, postupujte následovně:

  1. Roztáhnou úložiště. Klikněte na tlačítko Fork v pravém horním rohu stránky a postupujte podle pokynů.
  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í. Informace o opravách chyb během období stabilizace verze najdete v nejnovější prerelease/* větvi. Nové funkce by vždy měly být součástí main.

Pokud s pracovním postupem Gitu začínáte, podívejte se na tento úvod z GitHubu.

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

  1. Implementujte opravu chyby nebo funkci. Pokyny pro sestavení a nasazení SADY 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é ukázkovou scénu, která funkci demonstruje.
  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 na stránce UnitTests.
  5. Ujistěte se, že kód a funkce jsou zdokumentované podle pokynů k dokumentaci.
  6. Ujistěte se, že kód funguje na všech platformách podle očekávání. Seznam podporovaných platforem najdete v poznámkách k verzi . U projektů Windows UPW musí být kód kompatibilní s WACK. Chcete-li to provést, vygenerujte řešení sady Visual Studio, klikněte pravým tlačítkem na projekt; Úložiště>Vytváření balíčků 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 přijetí změn postupujte podle pokynů v části Žádosti o přijetí změn.