Contribución a herramientas de gráficos: MRTK3

Actualización del paquete

1. Bifurcar el repositorio y crear una rama. La nomenclatura de rama recomendada es user/username/feature.
2. Clone y abra el proyecto de GraphicsToolsUnityProject ejemplo en Unity.
3. Realice los cambios deseados. De forma predeterminada, todas las modificaciones del MRTK Graphics Tools paquete se publicarán en el paquete Herramientas de gráficos. (Si desea actualizar los ejemplos, consulte la sección siguiente).
4. Inserte la rama en la bifurcación y cree una solicitud de incorporación de cambios. Agregue una descripción de los cambios en la solicitud de incorporación de cambios. Las imágenes y los gifs siempre se aprecian.

Actualización de los ejemplos de paquete

Los ejemplos existen en la subcarpeta Samples~ como se describe en las recomendaciones de ejemplo de Unity. El carácter '~' impide que Unity importe la carpeta Samples~ . Esto es ideal cuando se incluye el paquete a través del administrador de paquetes. Pero no cuando desea actualizar los ejemplos dentro del paquete.

Si desea contribuir a los cambios en los ejemplos, debe realizar un cambio local temporal en la estructura de directorios del proyecto de Unity.

1. Abra GraphicsToolsUnityProject en Unity. La carpeta Ejemplos no estará visible en el MRTK Graphics Tools paquete de forma predeterminada. Para mostrar los ejemplos, seleccione Herramientas > de gráficos de ventana > Mostrar ejemplos en la barra de menús del archivo.
2. Realice los cambios deseados en los ejemplos.
3. Importante: Cuando haya terminado y antes de confirmar los cambios, recuerde ocultar los ejemplos. Seleccione Herramientas > de gráficos de ventana > Ocultar ejemplos en la barra de menús del archivo.

Sugerencia

Si no se invoca el elemento de menú Ocultar ejemplos de herramientas > de gráficos de ventana > después de editar ejemplos, git pensará que todos los archivos de ejemplo han cambiado. Una vez que se ocultan los ejemplos, los archivos reales cambiados deben ser evidentes en git.

Actualización de la documentación

Documentación de referencia de API

Para los comentarios de documentación, use el estilo en línea recomendado a continuación:

/// <summary>
/// Class <c>Point</c> models a point in a two-dimensional plane.
/// </summary>
public class Point
{
    /// <summary>
    /// Method <c>Draw</c> renders the point.
    /// </summary>
    void Draw() {...}
}

Documentación conceptual

Para actualizar documentos conceptuales, vaya al repositorio de documentos Mixed Reality.

Sugerencia

Los artículos relacionados con las herramientas de gráficos se pueden encontrar en esta carpeta mixed-reality/mrtk-unity/mrtk3-graphicstools/

Para empezar, siga estas recomendaciones para contribuir a la documentación de Microsoft Learn y la guía para contribuir a Mixed Reality documentación para desarrolladores.