Contribution au projet World Locking Tools pour Unity
La façon la plus intéressante de contribuer au projet World Locking Tools à l’heure actuelle consiste à déposer des problèmes. Les commentaires sur l’amélioration de l’alignement du projet World Locking Tools pour Unity avec les besoins de votre projet sont extrêmement précieux.
Si tous les commentaires que vous publiez sont précieux, voici quelques conseils pour rendre les vôtres plus actionnables.
Utilisez les étiquettes de manière appropriée
Lors de la soumission initiale d’un problème, et lorsqu’il s’agit d’un problème en tant que contributeur, l’utilisation correcte des étiquettes est très utile pour la coordination avec les autres contributeurs.
Essayez de différencier précisément les bogues, les demandes de fonctionnalité et les suggestions plus larges. Tous sont utiles, mais sont d’autant plus précieux qu’ils sont identifiés correctement.
De même, si une question ne semble pas pouvoir être traitée dans sa forme actuelle, l’application de l’étiquette appropriée (par exemple, « à clarifier ») peut vous aider à l’améliorer pour qu’elle puisse être traitée. Les commentaires spécifiques dans le problème lui-même sont, bien sûr, extrêmement précieux. Toutefois, l’étiquette appropriée peut permettre à d’autres utilisateurs de voir un commentaire qui pourrait sinon passer inaperçu.
Signalement d’un bogue
Les problèmes peuvent être envoyés à partir du portail consacré aux problèmes sur GitHub. Prendre le temps de signaler un problème ou de faire une suggestion dont les autres bénéficieront également est toujours apprécié.
Chaque rapport de bogue a son propre contexte, mais en général, plus les éléments suivants sont inclus, plus le problème peut être résolu rapidement.
Fichiers journaux de l’appareil
Les fichiers journaux de l’appareil peuvent être très utiles pour examiner les problèmes, en particulier conjointement avec les captures d’écran suggérées ci-dessous. Vous pouvez les obtenir en utilisant le portail d’appareil Windows lorsque vous êtes connecté à votre appareil, sous Système > Explorateur de fichiers > Dossiers utilisateur \ LocalAppData \ WorldLockingTools
Fichier journal de l’application Unity
UnityPlayer.log se trouve dans le sous-dossier TempState. Il s’agit d’un fichier texte brut.
L’enregistrement des diagnostics de World Locking Tools
Le fichier de diagnostic se trouve dans le sous-dossier LocalState. Le nom du fichier est généré automatiquement selon le modèle suivant :
FrozenWorld-<device name>-<capture date and time>.hkfwIl s’agit d’un fichier binaire qui nécessite un logiciel spécialisé pour être examiné.
Notez que pour capturer un enregistrement des diagnostics, vous devez activer l’enregistrement des diagnostics sur le composant Gestionnaire de World Locking Tools dans votre scène. Pour plus d’informations, consultez la documentation relative aux diagnostics.
Étapes de reproduction
Spécifiez la fréquence à laquelle le problème se produit. L’idéal est d’avoir un bogue qui se produit 100 % du temps en suivant un certain ensemble d’étapes. Mais même pour un bogue que vous n’avez vu qu’une seule fois, plus vous pouvez identifier les étapes menant au problème, mieux c’est.
Les étapes de reproduction doivent respecter la forme générale suivante :
- À partir de cet état stable normal...
- J’ai fait ceci (ou remarqué cette chose inhabituelle)...
- Le système a commencé à présenter ce comportement incorrect...
Captures d'écran
Les captures d’écran vous aident à identifier le contexte complet dans lequel le problème s’est produit. En particulier, l’affichage des diagnostics de World Locking Tools à l’écran peut vous aider à mettre en corrélation votre expérience avec les informations des journaux. Les captures d’écran peuvent être des images d’instantané ou des captures vidéo.
Informations sur l’appareil
- Quel type d’appareil ?
- Quelle version du système d’exploitation utilisez-vous ?
Environnement de génération
- Version d’Unity
- Version de Visual Studio
Proposition d’une fonctionnalité
Si vous constatez que World Locking Tools fait presque ce dont vous avez besoin, il est probable que quelqu’un d’autre souffre de la même limitation. Nous sommes tout aussi intéressés à combler les lacunes de notre documentation et de nos exemples qu’à fournir de nouvelles fonctionnalités.
Lorsque vous proposez une nouvelle fonctionnalité, il est très utile de préciser ce que vous cherchez à obtenir. Si les idées sur la manière de la mettre en œuvre peuvent également être utiles, les propositions qui mettent clairement en évidence la valeur ajoutée ont plus de chances d’être retenues. Le problème que la fonctionnalité résout de façon évidente, de préférence avec ce que vous pourriez en faire dans un scénario réel.
Veillez à associer l’étiquette « amélioration » au problème envoyé.
Contribution au code
Il s’agit d’un projet open source, ainsi tout le monde peut le dupliquer pour le développer à tout moment. Si une personne est suffisamment généreuse pour partager son travail, cela est très apprécié, que les changements soient récupérés dans le référentiel principal ou non.
Au cours de cette période initiale de déploiement, nous disposerons de ressources limitées pour examiner et accepter les demandes de tirage dans le référentiel principal. Il est conseillé d’éviter d’investir beaucoup de temps dans une duplication en supposant qu’elle sera réintégrée dans le référentiel principal.
Une façon d’atténuer le risque est de soumettre une question proposant ce qui est prévu (étiquetée « amélioration ») avant d’investir du temps dans une mise en œuvre. Cela concerne également les autres contributeurs qui peuvent examiner la même zone problématique.