Mitwirken am Projekt „World Locking Tools for Unity“
Die sinnvollste Art, zum World Locking Tools-Projekt beizutragen, besteht derzeit in der Meldung von Problemen. Jedwedes Feedback zur besseren Abstimmung des World Locking Tools for Unity-Projekts auf Ihre Projektanforderungen ist von großem Wert.
Nachfolgend finden Sie einige Tipps dazu, wie Ihre Rückmeldungen noch besser von uns verwertet werden können.
Richtige Kennzeichnung
Sowohl beim erstmaligen Einreichen eines Problems als auch bei der Weiterverfolgung eines Problems als Mitwirkender ist die korrekte Verwendung der Kennzeichnungen äußerst hilfreich für die Koordination mit anderen Mitwirkenden.
Unterscheiden Sie möglichst genau zwischen Fehlern, Featureanforderungen und allgemeinen Vorschlägen für die Zukunft. Jede dieser Rückmeldungen ist nützlich, aber sie ist noch nützlicher, wenn sie als solche erkannt wird.
Ebenso kann ein Issue, das in seiner jetzigen Form nicht handlungsrelevant zu sein scheint, durch eine entsprechende Kennzeichnung (z. B. „unklar“) besser bearbeitet werden. Spezifische Kommentare im Issue selbst sind natürlich von großem Nutzen. Aber die richtige Kennzeichnung kann andere dazu bringen, einen Kommentar wahrzunehmen, der sonst vielleicht unbemerkt bliebe.
Melden eines Fehlers
Issues können über das Portal für Issues auf GitHub gemeldet werden. Wir schätzen es sehr, wenn Sie sich die Zeit nehmen, ein Problem zu melden oder einen Vorschlag zu machen, von dem auch andere profitieren können.
Jeder Fehlerbericht hat seinen eigenen Kontext, aber im Allgemeinen gilt: Je mehr der unten aufgeführten Informationen enthalten sind, desto schneller kann ein Problem behoben werden.
Protokolldateien vom Gerät
Protokolldateien des Geräts können bei der Untersuchung von Problemen ungemein hilfreich sein, insbesondere in Verbindung mit den unten vorgeschlagenen Screenshots. Sie können über das Windows-Geräteportal abgerufen werden, während Sie mit Ihrem Gerät verbunden sind, und zwar unter „System“ > „Datei-Explorer“ > „Benutzerordner\LocalAppData\WorldLockingTools“.
Protokolldatei der Unity-App
Die Protokolldatei UnityPlayer.log befindet sich im Unterordner TempState. Es handelt sich hierbei um eine reine Textdatei.
Diagnoseprotokoll von World Locking Tools
Die Diagnosedatei befindet sich im Unterordner LocalState. Der Name der Datei wird automatisch nach folgendem Muster generiert:
FrozenWorld-<device name>-<capture date and time>.hkfwEs handelt sich um eine Binärdatei, zu deren Untersuchung spezielle Software benötigt wird.
Hinweis: Für eine Diagnoseaufzeichnung muss die Funktion „Diagnostics Recording“ für die World Locking Tools Manager-Komponente in Ihrer Szene aktiviert werden. Details hierzu finden Sie in der Dokumentation zur Diagnose.
Schritte für erneutes Vorschreiben
Geben Sie an, wie häufig das Problem auftritt. Im Idealfall tritt ein Fehler in 100 % der Fälle auf, wenn eine bestimmte Abfolge von Schritten ausgeführt wird. Aber auch für einen Fehler, der nur ein einziges Mal aufgetreten ist, gilt: Je detaillierter Sie die Schritte beschreiben können, die zu dem Problem geführt haben, desto besser.
Die Schritte zur Reproduktion eines Fehlers sollten der folgenden allgemeinen Form folgen:
- Ausgehend von diesem stabilen Normalzustand...
- Habe ich folgende Schritte ausgeführt (oder diese ungewöhnliche Situation bemerkt)...
- Dann begann das System, dieses falsche Verhalten zu zeigen...
Bildschirmaufnahmen
Anhand von Screenshots lässt sich der gesamte Kontext ermitteln, in dem das Problem aufgetreten ist. Insbesondere die Anzeige der World Locking Tools-Diagnose auf dem Bildschirm kann dazu beitragen, Ihre Beobachtungen mit den Informationen in den Protokollen zu korrelieren. Screenshots können entweder Momentaufnahmen oder Videoaufnahmen sein.
Geräteinformationen
- Um welche Art von Gerät handelt es sich?
- Welche Betriebssystemversion wird ausgeführt?
Buildumgebung
- Unity-Version
- Visual Studio-Version
Vorschlagen eines Features
Wenn Sie feststellen, dass World Locking Tools Ihre Anforderungen fast erfüllt, stehen die Chancen gut, dass jemand anderes die gleichen Erfahrungen gemacht hat. Wir sind ebenso daran interessiert, Lücken in unserer Dokumentation und unseren Beispielen zu schließen, wie neue Funktionen bereitzustellen.
Wenn Sie ein neues Feature vorschlagen, ist es besonders hilfreich, klar darzulegen, was Sie mit dem Feature erreichen möchten. Zwar können auch Anregungen zur Umsetzung hilfreich sein, doch werden Vorschläge, die den Mehrwert verdeutlichen, mit größerer Wahrscheinlichkeit Gehör finden. Zeigen Sie das Problem auf, das mit dem Feature gelöst wird, und beschreiben Sie vorzugsweise, was Sie damit in einem realistischen Szenario erreichen könnten.
Achten Sie darauf, für den übermittelten Vorschlag die Kennzeichnung „Enhancement“ (Erweiterung) zu verwenden.
Beitragen von Code
Dies ist ein Open-Source-Projekt, deshalb steht es jedem Entwickler frei, einen Fork zu erstellen, um daran zu arbeiten. Wir freuen uns sehr, wenn ein Entwickler so großzügig ist, seine Arbeit mit anderen zu teilen – unabhängig davon, ob sie in das Hauptrepository aufgenommen wird oder nicht.
Während dieser anfänglichen Einführungsphase verfügen wir nur über begrenzte Ressourcen, um Pull Requests für das Hauptrepository zu prüfen und zu akzeptieren. Es empfiehlt sich daher, nicht zu viel Zeit in einen Fork zu investieren, weil man annimmt, dass er in das Hauptrepository eingebunden wird.
Zur Minimierung des Risikos können Sie einen Verbesserungsvorschlag (mit der Kennzeichnung „Enhancement“) einreichen, bevor Sie viel Zeit in eine Implementierung investieren. Dies ist auch im Hinblick auf andere Mitwirkende sinnvoll, die sich möglicherweise mit demselben Problembereich befassen.