Mitwirken an MRTK2

Mixed Reality Toolkit (MRTK) begrüßt Beiträge aus der Community. Alle großen oder kleinen Änderungen müssen den MRTK-Codierungsstandards entsprechen. Stellen Sie sicher, dass Sie bei der Entwicklung mit diesen vertraut sind, um Verzögerungen bei der Überprüfung der Änderung zu vermeiden.

Wenn Sie Fragen haben, wenden Sie sich bitte an den Mixed-Reality-Toolkit-Kanal auf Slack. Sie können der Slack-Community über den automatischen Einladungsversender beitreten.

Übermittlungsprozesse

Wir bieten verschiedene Möglichkeiten, um Es Entwicklern zu ermöglichen, an Mixed Reality Toolkit mitzuwirken, beginnend mit der Erstellung eines neuen Problems.

Auswählen des Problemtyps

Von hier aus können Sie Folgendes speichern:

  • Fehlerbericht: Funktionsproblem mit einer Mixed Reality Toolkit-Komponenten
  • Dokumentationsproblem: Problem mit Mixed Reality Toolkit-Dokumentation
  • Featureanforderung: Vorschlag für ein neues feature Mixed Reality Toolkit

Vorschlagen von Featureanforderungen

Wenn Sie ein neues Mixed Reality-Toolkit-Feature anfordern, ist es wichtig, den Kundenvorteil bzw. das zu lösende Problem zu dokumentieren. Nach der Übermittlung wird eine Featureanforderung auf GitHub überprüft und besprochen. Wir fördern eine offene und konstruktive Diskussion über jeden Featurevorschlag, um sicherzustellen, dass die Arbeit für einen großen Teil der Kunden von Vorteil ist.

Um zu vermeiden, dass das Feature überarbeitet werden muss, wird empfohlen, dass die Entwicklung des Features nicht während der Überprüfungsphase beginnt. Häufig deckt der Community-Überprüfungsprozess ein oder mehrere Probleme auf, die erhebliche Änderungen an der vorgeschlagenen Implementierung erfordern können.

Hinweis

Wenn Sie an etwas arbeiten möchten, das bereits in unserem Backlog vorhanden ist, können Sie dieses Arbeitselement als Vorschlag verwenden. Stellen Sie sicher, dass Sie auch die Aufgabe kommentieren, die Die Betreuer darüber informiert, dass Sie daran arbeiten, sie abzuschließen.

Beitragsprozess

Führen Sie zum Einstieg diese Schritte aus:

  1. Forke das Repository. Klicken Sie oben rechts auf der Seite auf die Schaltfläche "Fork", und folgen Sie dem Ablauf.
  2. Erstellen Sie einen Branch in Ihrem Fork (außerhalb des Standard Branchs), um das Isolieren von Änderungen zu vereinfachen, bis sie für die Übermittlung bereit sind. Für Fehlerbehebungen während eines Releasestabilisierungszeitraums suchen Sie nach dem neuesten prerelease/* Branch. Neue Features sollten immer in eingefügt werden main.

Wenn Sie noch nicht mit dem Git-Workflow sind, lesen Sie diese Einführung auf GitHub.

Wenn Sie eine Fehlerbehebung oder ein Feature hinzufügen, führen Sie die folgenden Schritte aus:

  1. Implementieren Sie die Fehlerbehebung oder das Feature. Anweisungen zum Erstellen und Bereitstellen von MRTK finden Sie unter Bereitstellen auf HoloLens- und WMR-Geräten. Denken Sie daran, die Codierungsrichtlinien zu befolgen.
  2. Wenn Sie ein Feature hinzufügen, fügen Sie auch eine Beispielszene hinzu, die das Feature veranschaulicht.
  3. Wenn Sie ein experimentelles Feature hinzufügen, ist das Schreiben von Tests und Dokumentationen nicht erforderlich. Befolgen Sie stattdessen experimentelle Featurerichtlinien.
  4. Fügen Sie Tests hinzu, um die Fehlerbehebung bzw. das Feature zu überprüfen. Anweisungen zum Schreiben und Ausführen von Tests finden Sie unter UnitTests.
  5. Stellen Sie sicher, dass der Code und die Features wie in den Dokumentationsrichtlinien beschrieben dokumentiert sind.
  6. Stellen Sie sicher, dass der Code auf allen Plattformen wie vorgesehen funktioniert. Die Liste der unterstützten Plattformen finden Sie in den Versionshinweisen . Für Windows-UWP-Projekte muss Der Code WACK-kompatibel sein. Generieren Sie hierzu eine Visual Studio-Projektmappe, und klicken Sie mit der rechten Maustaste auf das Projekt. Abspeichern>Erstellen sie App-Pakete. Befolgen Sie die Anweisungen, und führen Sie WACK-Tests aus. Stellen Sie sicher, dass sie alle erfolgreich sind.
  7. Befolgen Sie die Anweisungen unter Pull Requests , wenn Sie einen Pull Request erstellen.