Contribution à MRTK2

Mixed Reality Toolkit (MRTK) accueille les contributions de la communauté. Toutes les modifications doivent être petites ou volumineuses, doivent respecter les normes de codage MRTK. Assurez-vous donc que vous êtes familiarisé avec ceux-ci tout en développant pour éviter les retards lorsque la modification est en cours de révision.

Si vous avez des questions, contactez le canal mixed-reality-toolkit sur Slack. Vous pouvez rejoindre la communauté Slack par le biais de l’envoi d’invitation automatique.

Processus d’envoi

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

Sélectionner le type de problème

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

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

Proposer des demandes de fonctionnalités

Lors de la demande d’une nouvelle fonctionnalité Mixed Reality Toolkit, il est important de documenter l’avantage client/le problème à résoudre. Une fois envoyée, une demande de fonctionnalité sera examinée et abordée sur GitHub. Nous encourageons les discussions ouvertes et constructives de chaque proposition de caractéristiques afin de garantir que le travail est bénéfique pour un grand segment de clients.

Pour éviter de devoir retravailler la fonctionnalité, il est généralement recommandé que le développement de la fonctionnalité ne commence pas pendant la phase de révision. Plusieurs fois, le processus d’examen communautaire découvre un ou plusieurs problèmes qui peuvent nécessiter des changements importants dans la mise en œuvre proposée.

Notes

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 qui informe les mainteneurs que vous travaillez pour le terminer.

Processus de contribution

Pour commencer, procédez simplement comme suit :

  1. Dupliquez (fork) 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 duplication (hors de la branche principale ) pour faciliter l’isolation des modifications jusqu’à ce qu’elles soient prêtes pour 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 entrer main.

Si vous débutez avec le flux de travail Git, consultez cette introduction à partir de Github.

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

  1. Implémentez la fonctionnalité ou le correctif de bogues. Les instructions de création et de déploiement de MRTK sont disponibles sur le déploiement sur les 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 de fonctionnalité expérimentales.
  4. Ajoutez des tests pour vérifier le correctif de bogue /fonctionnalité. Les instructions relatives à l’écriture et à l’exécution de tests se trouvent sur UnitTests.
  5. Vérifiez que le ou les composants du code et des 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 de la liste des plateformes prises en charge. Pour les projets UWP Windows, 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 les tests WACK. Assurez-vous qu’ils réussissent tous.
  7. Suivez les instructions des demandes de tirage lors de l’établissement d’une demande de tirage.