Bidra till MRTK2

  • Artikel

Mixed Reality Toolkit (MRTK) välkomnar bidrag från communityn. Alla ändringar, stora som små, måste följa MRTK-kodningsstandarderna. Se till att du är bekant med dessa när du utvecklar för att undvika fördröjningar när ändringen granskas.

Om du har några frågor kan du kontakta kanalen mixed-reality-toolkit på Slack. Du kan gå med i Slack-communityn via den automatiska inbjudningssändaren.

Inlämningsprocesser

Vi tillhandahåller flera sökvägar som gör det möjligt för utvecklare att bidra till Mixed Reality Toolkit, allt från och med att skapa ett nytt problem.

Välj problemtyp

Härifrån filar du:

  • Felrapport – Funktionsproblem med någon av Mixed Reality Toolkit-komponenter
  • Dokumentationsproblem – Problem med Mixed Reality Toolkit-dokumentation
  • Funktionsförfrågan – Förslag på en ny Mixed Reality Toolkit-funktion

Föreslå funktionsbegäranden

När du begär en ny Mixed Reality Toolkit-funktion är det viktigt att dokumentera kundförmånen/problemet som ska lösas. När en funktionsbegäran har skickats granskas och diskuteras den på GitHub. Vi uppmuntrar till en öppen och konstruktiv diskussion om varje funktionsförslag för att säkerställa att arbetet är fördelaktigt för ett stort antal kunder.

För att undvika att behöva omarbeta funktionen rekommenderar vi att utvecklingen av funktionen inte påbörjas under granskningsfasen. Många gånger upptäcker communityns granskningsprocess ett eller flera problem som kan kräva betydande ändringar i den föreslagna implementeringen.

Anteckning

Om du vill arbeta med något som redan finns i vår kvarvarande uppgifter kan du använda den arbetsuppgiften som ditt förslag. Se också till att kommentera uppgiften som meddelar underhållarna att du arbetar för att slutföra den.

Bidragsprocess

Kom igång genom att följa dessa steg:

  1. Förgrena lagringsplatsen. Klicka på knappen "Förgrening" längst upp till höger på sidan och följ flödet.
  2. Skapa en gren i din förgrening (utanför huvudgrenen ) för att göra det enklare att isolera ändringar tills de är klara för inlämning. Leta efter den senaste prerelease/* grenen för felkorrigeringar under en lanseringsstabiliseringsperiod. Nya funktioner bör alltid gå till main.

Om du inte har använt Git-arbetsflödet tidigare kan du läsa den här introduktionen från GitHub.

Följ dessa steg när du lägger till en felkorrigering eller funktion:

  1. Implementera felkorrigeringen eller funktionen. Anvisningar för att skapa och distribuera MRTK finns i Distribuera till HoloLens- och WMR-enheter. Kom ihåg att följa riktlinjerna för kodning.
  2. Om du lägger till en funktion lägger du även till en exempelscen som visar funktionen.
  3. Om du lägger till en experimentell funktion behöver du inte skriva tester och dokumentation. Följ i stället riktlinjerna för experimentella funktioner.
  4. Lägg till tester för att verifiera felkorrigeringen/funktionen. Anvisningar för att skriva och köra tester finns i UnitTests.
  5. Se till att koden och funktionerna är dokumenterade enligt beskrivningen i riktlinjerna för dokumentation.
  6. Se till att koden fungerar som den är avsedd på alla plattformar. Se Viktig information för listan över plattformar som stöds. För Windows UWP-projekt måste koden vara WACK-kompatibel. Det gör du genom att generera en Visual Studio-lösning, högerklicka på projektet. Lagra>Skapa apppaket. Följ anvisningarna och kör WACK-tester. Se till att alla lyckas.
  7. Följ anvisningarna i Pull Requests (Pull-begäranden ) när du gör en pull-begäran.