Share via

Contribution à MRTK2

  • Article

Mixed Reality Toolkit (MRTK) accueille contributions de la communauté. Toutes les modifications, grandes ou petites, doivent respecter les normes de codage MRTK. Assurez-vous que vous êtes familiarisé avec ceux-ci lors de l’élaboration afin d’éviter les retards lorsque la modification est en cours d’examen.

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 de soumission

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

Sélectionner le type de problème

À partir de là, vous déposez :

  • 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 du kit de ressources Mixed Reality
  • 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 à résoudre pour le client. Une fois envoyée, une demande de fonctionnalité est examinée et discutée sur GitHub. Nous encourageons une discussion ouverte et constructive de chaque proposition de fonctionnalité pour garantir que le travail est bénéfique pour un large segment de clients.

Pour éviter d’avoir à retravailler la fonctionnalité, il est recommandé que le développement de la fonctionnalité ne commence pas 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 modifications importantes 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 informant les mainteneurs que vous travaillez à la terminer.

Processus de contribution

Pour commencer, suivez ces instructions :

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

Si vous débutez dans le flux de travail Git, case activée cette présentation de GitHub.

Lorsque vous ajoutez un correctif de bogue ou une fonctionnalité, procédez comme suit :

  1. Implémentez le correctif ou la fonctionnalité de bogue. Les instructions relatives à la création et au déploiement de MRTK se trouvent 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. Suivez plutôt les instructions relatives aux 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 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éez des packages d’application. Suivez les invites et exécutez des tests WACK. Assurez-vous qu’ils réussissent tous.
  7. Suivez les instructions fournies dans Demandes de tirage lors de la création d’une demande de tirage.