RFC: Mejora en la Creación de Issues en GitHub

[daniel-villada]

Hola, dado que el proyecto está tomando fuerza y cada día se suman más personas a colaborar en el mismo, propongo mejorar el proceso de creación de issues en nuestros repositorios de GitHub mediante la inclusión de información detallada que facilite la comprensión y resolución de problemas por parte de los desarrolladores. Entiendo que a veces, por cuestiones de tiempo, resulta difícil llevar a cabo este tipo de prácticas, pero al aplicarlas reduciríamos algunos problemas a la hora de asignación o de tomar algún issue.

Motivación:

Actualmente, muchos issues carecen de información clave, lo que dificulta su comprensión y resolución. La propuesta busca estandarizar la creación de issues proporcionando detalles de aprobación, una descripción clara del problema y posibles instrucciones técnicas.

Detalles de la Propuesta:

Obligar a proporcionar una descripción detallada del problema. Se debe incluir información como:

• Contexto: Explicación del contexto en el que se produce el problema.
• Pasos para Reproducir: Lista detallada de pasos para reproducir el problema.
• Resultado Esperado: Descripción clara del resultado que se espera.
• Capturas de Pantalla: Esto puede ser opcional, se pueden incluir capturas de pantalla que ilustren el problema.

Instrucciones Técnicas:

Incluir un campo para proporcionar instrucciones técnicas que ayuden al desarrollador a comenzar a trabajar en el issue. Esto puede incluir:

• Tecnologías Utilizadas: Enumerar las tecnologías específicas relacionadas con el problema.
• Pistas para la Solución: Proporcionar sugerencias o pistas sobre posibles enfoques para resolver el problema.

Beneficios Esperados:

• Mejora en la calidad y claridad de los issues.
• Facilita la colaboración entre desarrolladores al proporcionar información detallada.
• Acelera el proceso de resolución de problemas al proporcionar instrucciones técnicas claras.

Implementación:

La implementación de esta mejora puede llevarse a cabo mediante la configuración de plantillas predefinidas para issues y la configuración de campos obligatorios. Un ejemplo podría ser...

Consideraciones:
Es importante comunicar esta nueva práctica a los colaboradores del repositorio y proporcionar orientación sobre cómo completar los campos obligatorios.