search

Villanuevand / openve-cli

📡 Localiza las comunidades tecnológicas de Venezuela 🇻🇪 que hacen vida en Telegram reconocidas por OpenVE.
MIT License
14 stars 4 forks source link

Plantilla para issue #8

Open Villanuevand opened 6 years ago

Villanuevand commented 6 years ago

Se debe crear una plantilla para issues, toda la documentación al respecto se encuentran en el artículo Creating an issue template for your repository de la ayuda de Github.

Wgil commented 6 years ago

Saludos!

Si aún no han comenzado con esto, me ofrezco.

Propuesta

Para bugs: steps to reproduce, expected and actual result, version. Algo simple de este estilo https://github.com/stevemao/github-issue-templates/blob/master/simple/ISSUE_TEMPLATE.md Sería bueno incluir también un template al estilo jsfiddle, donde esté instalada la herramienta openve-cli y los contribuyentes puedan ejecutar el test-case y adjuntarlo al issue, tal vez no requerido, de manera opcional.

Para sugerencia de features será necesario?

Villanuevand commented 6 years ago

Hola @Wgil

Los issues si bien son problemas en algunos casos pueden ser proposiciones de mejora. Se puede usar la plantilla que compartiste como base y extender a las necesidades del proyecto.

Tienes libertad de proponer más orientado a lo que comenté, y no dudes en hacer un PULL REQUEST, estaré muy atento a tu actividad.

Wgil commented 6 years ago

Aquí está el PR:

https://github.com/Villanuevand/openve-cli/pull/11

Como comenté, me gustaría también añadir un paso opcional más con un jsfiddle donde se pueda correr la librería y el issue, pero creo que necesitaríamos un build version para esto. Me equivoco? De ser así, me ofrezco a crear el builder del proyecto también.

Me llama la atención el formato de los commits, hay alguna herramienta que facilita su visualización dado el formato de commits?

leocabeza commented 6 years ago

No veo que tan práctico sea @Wgil, si es un issue, con sólo mencionar los Pasos para reproducir debería ser suficiente. Pero es mi opinión solamente

Wgil commented 6 years ago

@leocabeza Suele ser util cuando es un issue un poco complejo de reproducir, además de los pasos, tienes ya el ejemplo del problema a la mano. Al igual que si los pasos escritos no fueron claros o ambiguos. También si hay muchos issues abiertos es una manera fácil de ejecutar y probar lo que se está reportando, sin tener que estar en tu máquina, levantar el proyecto, etc.

leocabeza commented 6 years ago

Creo que es útil si fuera una página web, y de pronto un CSS que se ve mal en un navegador es un buen caso de uso del jsfiddle. Pero aquí no lo veo tan esencial, ¿Qué opina @Villanuevand?