Al formatear un problema de GitHub para MVVMCross, seguir las mejores prácticas puede mejorar la claridad, la eficiencia y la colaboración. Aquí hay algunas pautas detalladas:
1. Títulos descriptivos **
Use el estado de ánimo imperativo y asegúrese de que el título sea lo suficientemente descriptivo como para transmitir el propósito del problema. Evite terminar los títulos con períodos. Por ejemplo, "corrige el error en el enlace de datos" es más efectivo que el "error en el enlace de datos" o el "error de enlace de datos". [4] [7].2. Borrar descripción general **
Proporcione una descripción concisa del problema en dos líneas o menos. Esto debe incluir el objetivo principal o el problema que se aborde. Por ejemplo, "este problema tiene como objetivo resolver un error de enlace de datos que causa que la aplicación se bloquee en los dispositivos Android". [1] [4].3. Dependencia (si corresponde) **
Si el problema depende de otro problema que se resuelva primero, enlace a ese problema. Esto ayuda a mantener un flujo de trabajo claro y asegura que las tareas dependientes se aborden en el orden correcto. Por ejemplo, "este problema depende de [enlace al problema dependiente]." [1].4. Artículos de acción **
Formato de elementos de acción como listas de verificación que se puede hacer clic. Esto facilita el seguimiento del progreso y asignar tareas a los miembros del equipo. Por ejemplo:- [] Investigue la causa del error de enlace de datos.
- [] Implemente una solución para el problema identificado.
- [] Pruebe la solución en múltiples plataformas. [1] [4].
5. Recursos/Instrucciones **
Incluya enlaces a documentación o recursos relevantes que puedan ayudar a resolver el problema. Esto podría incluir tutoriales, documentación de API o discusiones anteriores relacionadas con el problema. Por ejemplo, "Consulte [Documentación MVVMCross] (https://mvvmcross.com/docs) para obtener orientación sobre el enlace de datos". [1] [2].6. Asesores **
Asigne el problema a un miembro de equipo específico. Esto garantiza la responsabilidad y la claridad sobre quién es responsable de la tarea. Use la función "Asignados" en GitHub para asignar usuarios. [1].7. Etiquetas **
Aplicar etiquetas relevantes para clasificar el problema. Esto ayuda a filtrar y priorizar problemas dentro del proyecto. Por ejemplo, las etiquetas pueden incluir "error", "característica" o "mejora". [1] [2].8. Junta del proyecto **
Asegúrese de que el problema se agrega a la junta del proyecto y se triabe adecuadamente. Esto implica establecer el estado del problema en "caja de hielo" si no está listo ", retraso priorizado" si está listo pero no asignado, y "en progreso" una vez asignado. [1].9. hitos **
Use hitos para rastrear el progreso de grupos de problemas o solicitudes de extracción. Esto es particularmente útil para proyectos más grandes o al rastrear múltiples tareas relacionadas. [1].10. Actualizaciones de documentación y progreso **
Actualice regularmente los comentarios del problema con progreso o cambios. Esto mantiene a todos los interesados informados y facilita la resolución de problemas de colaboración. [7].Ejemplo de un problema bien formato
** Título: corrige el error de enlace de datos en los dispositivos Android
** Descripción general: este problema aborda un error de enlace de datos que causa que la aplicación se bloquee en los dispositivos Android.
** Dependencia: depende de [enlace al problema dependiente].
Artículos de acción:
- [] Investigue la causa del error de enlace de datos.
- [] Implemente una solución basada en los hallazgos.
- [] Realice pruebas exhaustivas en todas las plataformas.
** Recursos/Instrucciones: consulte [Documentación MVVMCross] (https://mvvmcross.com/docs) para obtener una guía de enlace de datos.
** Asesores: @username
** Etiquetas: error, Android
Siguiendo estas pautas, puede crear problemas de GitHub bien estructurados que mejoren la colaboración y la eficiencia dentro del proyecto MVVMCross.
Citas:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tablas
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md