Beitrag zu MRTK2

Mixed Reality Toolkit (MRTK) begrüßt Beiträge der Community. Alle Änderungen sind klein oder groß, müssen den MRTK-Codierungsstandards entsprechen. Stellen Sie daher sicher, dass Sie mit diesen vertraut sind, während Sie entwickeln, um Verzögerungen zu vermeiden, wenn die Änderung überprüft wird.

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

Übermittlungsprozesse

Wir bieten mehrere Pfade, mit denen Entwickler zu Mixed Reality Toolkit beitragen können, beginnend mit dem Erstellen eines neuen Problems.

Problemtyp auswählen

Von hier aus datei:

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

Vorschlagen von Featureanforderungen

Wenn Sie ein neues Mixed Reality Toolkit-Feature anfordern, ist es wichtig, den Kundenvorteil / das Problem zu dokumentieren, das gelöst werden soll. Nach der Übermittlung wird eine Featureanfrage auf GitHub überprüft und diskutiert. Wir ermutigen offene und konstruktive Diskussionen über jeden Featurevorschlag, um sicherzustellen, dass die Arbeit für ein großes Kundensegment vorteilhaft ist.

Um die Überarbeitung des Features zu vermeiden, empfiehlt es sich im Allgemeinen, dass die Entwicklung des Features während der Überprüfungsphase nicht beginnt. Oft deckt der Community-Überprüfungsprozess ein oder mehrere Probleme auf, die erhebliche Änderungen in der vorgeschlagenen Implementierung erfordern können.

Hinweis

Wenn Sie an etwas arbeiten möchten, das bereits in unserem Backlog vorhanden ist, können Sie diese Arbeitsaufgabe als Vorschlag verwenden. Achten Sie darauf, dass Sie auch die Aufgabe kommentieren, die Betreuer benachrichtigt, dass Sie daran arbeiten, sie abzuschließen.

Beitragsprozess

Führen Sie einfach die folgenden Schritte aus, um zu beginnen:

  1. Forken Sie das Repository. Klicken Sie oben rechts auf der Seite auf die Schaltfläche "Freihand", und folgen Sie dem Fluss.
  2. Erstellen Sie eine Verzweigung in Ihrer Verzweigung (aus der Hauptzweigung ), damit Sie alle Änderungen einfacher isolieren können, bis sie zur Übermittlung bereit sind. Suchen Sie bei Fehlerkorrekturen während eines Releasestabilisierungszeitraums nach der neuesten prerelease/* Verzweigung. Neue Features sollten immer in main.

Wenn Sie dem Git-Workflow neu sind, schauen Sie sich diese Einführung von Github an.

Führen Sie die folgenden Schritte aus, wenn Sie eine Fehlerkorrektur oder ein Feature hinzufügen:

  1. Implementieren Sie die Fehlerkorrektur oder das Feature. Anweisungen zum Erstellen und Bereitstellen von MRTK finden Sie 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, sind das Schreiben von Tests und Dokumentationen nicht erforderlich. Befolgen Sie stattdessen experimentelle Featurerichtlinien.
  4. Fügen Sie Tests hinzu, um die Fehlerkorrektur /Funktion zu überprüfen. Anweisungen zum Schreiben und Ausführen von Tests finden Sie bei UnitTests.
  5. Stellen Sie sicher, dass der Code und die Features dokumentiert sind, wie in den Dokumentationsrichtlinien beschrieben.
  6. Stellen Sie sicher, dass der Code auf allen Plattformen wie vorgesehen funktioniert. Weitere Informationen finden Sie in den Versionshinweisen für die Liste der unterstützten Plattformen. Für Windows UWP-Projekte muss Der Code WACK-konform sein. Generieren Sie dazu eine Visual Studio-Projektmappe, klicken Sie mit der rechten Maustaste auf das Projekt; Abspeichern>App-Pakete erstellen. Folgen Sie den Anweisungen, und führen Sie WACK-Tests aus. Stellen Sie sicher, dass sie alle erfolgreich sind.
  7. Folgen Sie den Anweisungen bei Pull-Anforderungen beim Erstellen einer Pullanforderung.