Contribución al proyecto World Locking Tools para Unity
La mejor manera de contribuir al proyecto World Locking Tools en este momento es abriendo incidencias. Todos los comentarios que ayuden a alinear mejor el proyecto World Locking Tools para Unity con las necesidades de su proyecto son sumamente importantes.
Aunque todos los comentarios que exponga son útiles, estas son algunas sugerencias para que sean más prácticos.
Uso adecuado de las etiquetas
Tanto en el envío inicial de una incidencia como en las comunicaciones siguientes como colaborador, un uso adecuado de las etiquetas resulta muy útil para coordinarse con otros colaboradores.
Intente diferenciar con precisión entre lo que es un error, lo que es la solicitud de una característica y lo que es una sugerencia más amplia de cara al futuro. Todos son de gran utilidad, pero lo son mucho más cuando se identifican como tales.
Del mismo modo, si no está claro cómo abordar una incidencia en su forma actual, la aplicación de la etiqueta adecuada [por ejemplo, "unclear" (confuso)] puede ayudar a mejorarla para poder buscar una solución. Los comentarios específicos en la propia incidencia son, por supuesto, muy valiosos. Pero la etiqueta adecuada puede llevar a otros usuarios a ver un comentario que, de otro modo, podría pasar inadvertida.
Notificación de un error
Las incidencias se pueden enviar desde el portal de incidencias de GitHub. Siempre se agradece el tiempo dedicado a notificar un problema o a hacer una sugerencia de la que otros se beneficiarán también.
Cada informe de errores tiene su propio contexto, pero, en general, cuantos más elementos de los que se indican a continuación se incluyan, más rápidamente se puede resolver un problema.
Archivos de registro del dispositivo
Los archivos de registro del dispositivo pueden ser enormemente útiles para investigar problemas, especialmente si van acompañados de las capturas de pantalla que se sugieren a continuación. Se pueden obtener en el Portal de dispositivos Windows mientras esté conectado al dispositivo, en Sistema > Explorador de archivos > carpetas del usuario\LocalAppData\WorldLockingTools.
Archivo de registro de la aplicación Unity
UnityPlayer.log se encuentra en la subcarpeta TempState. Es un archivo de texto sin formato.
Registro de diagnóstico de World Locking Tools
El archivo de diagnóstico se encuentra en la subcarpeta LocalState. El nombre del archivo se genera automáticamente siguiendo este patrón:
FrozenWorld-<device name>-<capture date and time>.hkfwEs un archivo binario que necesita software especializado para examinarlo.
Tenga en cuenta que, para capturar un registro de diagnóstico, es necesario habilitar la opción Diagnostics Recording (Registro de diagnóstico) en el componente World Locking Tools Manager en la escena. Consulte la documentación sobre diagnósticos para obtener más información.
Pasos de reproducción
Especifique con qué facilidad se produce el problema. Lo ideal es que sea un error que se produce siempre que se realiza una serie de pasos determinada. Pero, aunque sea un error que solo lo haya visto producirse una vez, cuanto más detalladamente redacte los pasos que dan lugar al problema, mejor.
Los pasos de reprobación deben tener el siguiente formato general:
- A partir de este estado estable normal...
- Hice esto (o noté esta cosa inusual)...
- Después, el sistema empezó a mostrar este comportamiento incorrecto...
Capturas de pantalla
Las capturas de pantalla ayudan a identificar el contexto completo en el que se produjo el problema. En concreto, poder ver los diagnósticos de World Locking Tools en la pantalla puede ayudar a poner en correlación su experiencia con la información de los registros. Las capturas de pantalla pueden ser instantáneas o capturas de vídeo.
Información del dispositivo
- ¿Qué tipo de dispositivo es?
- ¿Qué versión de sistema operativo ejecuta?
Entorno de compilación
- Versión de Unity
- Versión de Visual Studio
Propuesta de una característica
Cuando ve que World Locking Tools casi hace lo que necesita, lo más probable es que otra persona esté sufriendo la misma limitación. Estamos tan interesados en cerrar brechas en la documentación y los ejemplos como en proporcionar nuevas características.
Al proponer una nueva característica, es muy importante dejar claro lo que está intentando hacer. Aunque las ideas sobre cómo implementarla también pueden ser útiles, es más probable que progresen las propuestas que aclaran el valor agregado. Haga que el problema que la característica resolvería sea obvio, preferiblemente con lo que podría lograr con él en un escenario real.
Asegúrese de agregar la etiqueta "enhancement" (mejora) a la incidencia de propuesta que envíe.
Código de contribución
Este es un proyecto de código abierto, por lo que, por supuesto, cualquiera puede crear una bifurcación de desarrollo en cualquier momento. Si alguien es lo suficientemente generoso como para compartir su trabajo, se agradece muchísimo, tanto si lo inserta en el repositorio principal como si no.
Durante este período de implementación inicial, tendremos recursos limitados para revisar y aceptar solicitudes de incorporación de cambios en el repositorio principal. Es aconsejable no invertir mucho tiempo en una bifurcación con la idea de que se fusionará mediante combinación con el repositorio principal.
Una forma de mitigar el riesgo es enviar una incidencia que sugiera lo que se pretende [con la etiqueta "enhancement" (mejora)] antes de invertir mucho tiempo en una implementación. Esto es también muy considerado con otros colaboradores que podrían estar trabajando en la misma área de la incidencia.