Github Issue
Issue
Un Issue es una nota en un repositorio que trata de llamar la atención sobre un problema. Puede ser un error a corregir, una petición para añadir una nueva opción o característica, una pregunta para aclarar algún tema que no está correctamente aclarado o muchas otras cosas diferentes. En GitHub puedes etiquetar, buscar o asignar Issues, haciendo que la gestión de un proyecto activo sea más sencilla.
Un issue es una nota en un repositorio acerca de algo que necesita nuestra atención. Si encuentras un bug en un proyecto que estás usando (y no sabes cómo resolverlo), tienes problemas con la documentación o tienes una pregunta, crea un issue. En GitHub puedes ponerles etiqueta, asignarlos a usuarios y hacer búsquedas. Se gestionan los issues desde GitHub.com. (más info)
Breve guía para abrir un Issue
- Asegúrate de que tu petición no se ha hecho ya con anterioridad. Evita duplicar peticiones. Aprende cómo buscar issues
- Si nadie ha hecho un issue con tu petición. Haz click en la pestaña Issues de la barra lateral.
- Haz click en el botón de New Issue
- Dale un título suficientemente descriptivo y un texto aclaratorio de tu petición. Cuanto más claro seas, mejor.
- Explica el problema, cuál es el resultado esperado y cual es el realmente obtenido.
- Detalla uno a uno los pasos para repetir el problema. Incluye detalles como el sistema operativo, el navegador utilizado, la librería, o las versiones del software implicados en el mismo.
- Pega los mensajes de error o el contenido de los logs en el mismo pull request o en un Gist. En caso de pegarlo en el propio texto abre y cierra con tres acentos franceses así: ``` que permiten que el código se muestre correctamente.
- Haz click en Submit New Issue cuando hayas terminado. Ahora este Issue tiene una URL permanente que puedes referenciar para compartir.
Si quieres profundizar en el tema, sigue el siguiente enlace de la documentación oficial de GitHub: Mastering Issues
Fuente:
https://wikis.fdi.ucm.es/ELP/Guía_rápida_de_Github
https://ropenspain.es/docs/issues_pull_requests/