Contribution à MRTK2

Mixed Reality Toolkit (MRTK) accueille les contributions de la communauté. Toutes les modifications, grandes ou petites, doivent respecter les normes de codage MRTK. Assurez-vous d’être familiarisé avec ces éléments lors du développement afin d’éviter les retards lors de la révision de la modification.

Si vous avez des questions, contactez le canal mixed-reality-toolkit sur Slack. Vous pouvez rejoindre la communauté Slack via l’expéditeur automatique de l’invitation.

Processus de soumission

Nous fournissons plusieurs chemins pour permettre aux développeurs de contribuer à Mixed Reality Kit de ressources, tout en commençant par créer un problème.

À partir de là, vous créez un fichier :

• Rapport de bogue - Problème de fonctionnalité avec l’un des composants de Mixed Reality Toolkit
• Problème de documentation - Problème avec la documentation Mixed Reality Toolkit
• Demande de fonctionnalité - Proposition d’une nouvelle fonctionnalité Mixed Reality Toolkit

Proposition de demandes de fonctionnalités

Lors de la demande d’une nouvelle fonctionnalité Mixed Reality Toolkit, il est important de documenter l’avantage/le problème client à résoudre. Une fois envoyée, une demande de fonctionnalité est examinée et traitée sur GitHub. Nous encourageons une discussion ouverte et constructive sur chaque proposition de caractéristique pour nous assurer que le travail est bénéfique pour un large segment de clients.

Pour éviter d’avoir à retravailler la fonctionnalité, il est recommandé de ne pas commencer le développement de la fonctionnalité pendant la phase de révision. À de nombreuses reprises, le processus d’examen communautaire révèle un ou plusieurs problèmes qui peuvent nécessiter des changements importants dans la mise en œuvre proposée.

Remarque

Si vous souhaitez travailler sur quelque chose qui existe déjà dans notre backlog, vous pouvez utiliser cet élément de travail comme votre proposition. Veillez également à commenter la tâche pour informer les chargés de maintenance que vous travaillez à la terminer.

Processus de contribution

Pour commencer, procédez comme suit :

1. Dupliquer le dépôt. Cliquez sur le bouton « Fork » en haut à droite de la page et suivez le flux.
2. Créez une branche dans votre fourche (hors de la branche principale ) pour faciliter l’isolation des modifications jusqu’à ce que vous activiez la soumission. Pour les correctifs de bogues pendant une période de stabilisation de mise en production, recherchez la branche la plus récente prerelease/* . Les nouvelles fonctionnalités doivent toujours être intégrées à main.

Si vous débutez avec le workflow Git, case activée cette introduction de GitHub.

Lors de l’ajout d’un correctif de bogue ou d’une fonctionnalité, procédez comme suit :

1. Implémentez le correctif ou la fonctionnalité de bogue. Vous trouverez des instructions sur la création et le déploiement de MRTK dans Déploiement sur des appareils HoloLens et WMR. N’oubliez pas de suivre les instructions de codage.
2. Si vous ajoutez une fonctionnalité, ajoutez également un exemple de scène qui illustre la fonctionnalité.
3. Si vous ajoutez une fonctionnalité expérimentale, l’écriture de tests et de documentation n’est pas nécessaire. Au lieu de cela, suivez les instructions des fonctionnalités expérimentales.
4. Ajoutez des tests pour vérifier le correctif/la fonctionnalité de bogue. Les instructions relatives à l’écriture et à l’exécution de tests se trouvent dans UnitTests.
5. Vérifiez que le code et les fonctionnalités sont documentés comme décrit dans les Instructions de documentation.
6. Vérifiez que le code fonctionne comme prévu sur toutes les plateformes. Consultez les notes de publication pour obtenir la liste des plateformes prises en charge. Pour les projets Windows UWP, le code doit être conforme à WACK. Pour ce faire, générez une solution Visual Studio, cliquez avec le bouton droit sur le projet . Boutique>Créer des packages d’application. Suivez les invites et exécutez des tests WACK. Assurez-vous qu’ils réussissent tous.
7. Suivez les instructions de demandes de tirage lorsque vous effectuez une demande de tirage.