Contribución a MRTK2
Mixed Reality Toolkit (MRTK) da la bienvenida a las contribuciones de la comunidad. Todos los cambios, grandes o pequeños, deben cumplir los estándares de codificación de MRTK. Asegúrese de que está familiarizado con estos durante el desarrollo para evitar retrasos cuando se revise el cambio.
Si tiene alguna pregunta, póngase en contacto con el canal mixed-reality-toolkit en Slack. Puede unirse a la comunidad de Slack a través del remitente de invitación automática.
Procesos de envío
Proporcionamos varias rutas de acceso para permitir que los desarrolladores contribuyan a Mixed Reality Toolkit, todo ello a partir de la creación de un nuevo problema.
Desde aquí usted archivo:
- Informe de errores: problema de funcionalidad con uno de los componentes de Mixed Reality Toolkit
- Problema de documentación: problema con la documentación de Mixed Reality Toolkit
- Solicitud de características: propuesta para una nueva característica Mixed Reality Toolkit
Proponer solicitudes de características
Al solicitar una nueva característica Mixed Reality Toolkit, es importante documentar la ventaja o problema del cliente que se va a resolver. Una vez enviada, se revisará y analizará una solicitud de característica en GitHub. Animamos a un debate abierto y constructivo de cada propuesta de características para garantizar que el trabajo sea beneficioso para un gran segmento de clientes.
Para evitar tener que volver a trabajar la característica, se recomienda que el desarrollo de la característica no comience durante la fase de revisión. Muchas veces, el proceso de revisión de la comunidad descubre uno o varios problemas que pueden requerir cambios significativos en la implementación propuesta.
Nota:
Si desea trabajar en algo que ya existe en nuestro trabajo pendiente, puede usar ese elemento de trabajo como propuesta. Asegúrese de comentar también sobre la tarea que notifica a los mantenedores que está trabajando para completarla.
Proceso de contribución
Para comenzar, asegúrese de lo siguiente:
- Bifurque el repositorio. Haga clic en el botón "Bifurcar" situado en la parte superior derecha de la página y siga el flujo.
- Cree una rama en la bifurcación (fuera de la rama principal ) para facilitar el aislamiento de los cambios hasta que esté listo para su envío. En el caso de las correcciones de errores durante un período de estabilización de versión, busque la rama más reciente
prerelease/*. Las nuevas características siempre deben entrar enmain.
Si no está familiarizado con el flujo de trabajo de Git, consulte esta introducción de GitHub.
Al agregar una corrección de errores o una característica, siga estos pasos:
- Implemente la corrección de errores o la característica. Las instrucciones para compilar e implementar MRTK se encuentran en Implementación en dispositivos HoloLens y WMR. No olvide seguir las directrices de codificación.
- Si agrega una característica, agregue también una escena de ejemplo que muestre la característica.
- Si agrega una característica experimental, no es necesario escribir pruebas y documentación. En su lugar, siga las directrices de características experimentales.
- Agregue pruebas para comprobar la corrección de errores o la característica. Las instrucciones para escribir y ejecutar pruebas se encuentran en UnitTests.
- Asegúrese de que el código y las características se documentan como se describe en las Directrices de documentación.
- Asegúrese de que el código funciona según lo previsto en todas las plataformas. Consulte las notas de la versión para obtener la lista de plataformas admitidas. En el caso de los proyectos de UWP de Windows, el código debe ser compatible con WACK. Para ello, genere una solución de Visual Studio, haga clic con el botón derecho en el proyecto; Tienda>Crear paquetes de aplicaciones. Siga las indicaciones y ejecute pruebas WACK. Asegúrese de que todos tienen éxito.
- Siga las instrucciones de Solicitudes de incorporación de cambios al realizar una solicitud de incorporación de cambios.