Cómo crear problemas de GitHub 5 veces más rápido
Los problemas de GitHub son fantásticos para rastrear nuevas funciones o errores, quién está asignado, categorizarlos, agregarlos a proyectos, etc. Al mismo tiempo, también son bastante lentos de crear y crear un montón de ellos consume demasiado tiempo.
Uno de los puntos débiles que veo con los problemas de GitHub en el trabajo es que son engorrosos de crear, especialmente para aquellos que no son desarrolladores o diseñadores, como gerentes o evaluadores, que desean informar un error sin pasar por el proceso de creación. en GitHub.
Hace un tiempo escribí sobre una aplicación que estaba escribiendo para acelerar la creación de problemas de GitHub. De hecho, construí la aplicación, pero luego olvidé escribir sobre ella aquí, así que aquí está la publicación de blog adecuada. En este post veremos:
- Escribir un lote de problemas de GitHub con texto sin formato
- La pila tecnológica detrás de la aplicación
- Más ideas para mejorar la creación de problemas
¿Por qué una aplicación para crear problemas de GitHub más rápido?
La interfaz de usuario de GitHub generalmente está bien para crear un problema. O dos. Y está bien para personas con conocimientos de tecnología, como desarrolladores o diseñadores. Sin embargo, en nuestra empresa Reconnect, a veces, después de desarrollar una nueva función, le pedimos a nuestro personal no técnico que la pruebe. Y eso funciona muy bien, porque generalmente encuentran algunos problemas. Pero les consume mucho ir y saltar a través de la interfaz de usuario de problemas de GitHub. Esto es aún más engorroso cuando tienen que crear más de un problema y probablemente en diferentes repositorios.
Si cuantificamos la cantidad de veces que cambiamos nuestra atención para crear problemas de GitHub una vez que hemos llegado a la página para crear un problema en el repositorio donde queremos crearlos, sería algo más o menos como esto:
- ingrese el título
- muévase al cuadro de texto del problema para ingresar la descripción
- vaya a la barra lateral para asignar el problema a alguien
- muévase al bloque Etiquetas en la barra lateral para agregar una etiqueta
- vaya y haga clic en el botón para crear realmente el problema
¡Son 5 veces cuando cambiamos nuestra atención de un área a otra! Demasiado cambio de atención para una tarea que es esencialmente escribir y demasiado tiempo dedicado a reenfocar. ¿Y si tienes que escribir un problema en un repositorio diferente? Tienes que navegar a ese repositorio en una pestaña nueva o en la actual y eso es más tiempo perdido.
Entonces, ¿cómo puede crear problemas de GitHub de manera más fácil y rápida? ¿No sería más fácil si pudiéramos hacerlo enfocados en un solo lugar sin tener que cambiar nuestra atención varias veces?
Escribir un lote de problemas de GitHub con texto sin formato
La escritura es una de las habilidades más básicas en los dispositivos, es más básica incluso que los gestos táctiles. Porque si bien esos son específicos para dispositivos táctiles, debe usar un mouse o un trackpad en otros. Pero la escritura suele ser siempre la misma. Y los problemas de GitHub son texto, entonces, ¿por qué no usar texto para crearlos sin tener que dejar nuestro teclado?
Esta aplicación hace exactamente eso: https://fast-issues.herokuapp.com/
Autorizas esta aplicación de GitHub y puedes comenzar a escribir problemas en todos tus repositorios. Solo tienes que seleccionar un repositorio donde quieras crear un número y comenzar a escribir varios números, uno en cada línea.
Y admite escribir el título y la descripción, asignarlo y etiquetarlo. Solo requiere el título del problema. El resto es todo opcional. Solo necesita seguir una cierta convención:
- el titulo es lo primero
- luego, un carácter de tubería separa a los asignados. Elegí que fuera así porque, como mínimo, necesitas un problema y alguien que trabaje en él.
- un segundo carácter vertical separa la descripción del problema. Puede tener cualquier longitud, pero no puede tener saltos de línea porque eso iniciaría un nuevo problema.
- un tercer carácter de tubería separa las etiquetas
Admite múltiples asignados y etiquetas separándolos con una coma. Así que básicamente:
This is the title | username1, username2 | This is the issue description, as long as you want it but without line breaks. | Label 1, Label 2<br>This is another issue | username3 | And another issue description | Bug
Una vez hecho esto, es cuestión de hacer clic en Ir! y creará todos los problemas. Cada uno te tendrá como autor. Luego puedes editarlos para agregar imágenes o videos, memes, cualquier cosa.
Si necesita crear más problemas en un repositorio diferente, simplemente vuelva a seleccionarlo en el menú desplegable y comience a escribir esos problemas. ¡No más saltos a través de las páginas!
La pila tecnológica detrás de la aplicación
El repositorio de esta aplicación se encuentra en https://github.com/eliorivero/fast-issues
La pila tecnológica es particularmente simple y completamente basada en JavaScript :
- interfaz construida con React
- backend construido con Node.js
- utiliza Express como servidor
- y Octokit REST una biblioteca para trabajar con la API de GitHub
Una cosa a tener en cuenta es que no queremos superar el límite de solicitudes permitidas por la API de problemas de GitHub. Recomiendan dejar pasar al menos un segundo entre solicitudes, por lo que pausé la ejecución 1,5 segundos entre la creación de cada problema.
Desde el prototipo inicial que hice hasta la versión final, la cambié de una aplicación de GitHub a una aplicación de OAuth. Es porque este último te permite crear problemas y aparecer como el autor.
Más ideas para mejorar la creación de problemas
Le mostré esto a un amigo y me dijo que tenía la idea de crear una extensión de Chrome para tomar una captura de pantalla de un error, anotarlo y enviarlo como un problema de GitHub. Pensé que era una gran idea, así que busqué una forma de tomar una captura de pantalla pero dentro de una aplicación React y rápidamente encontré html2canvas que permite tomar capturas de pantalla y guardarlas como archivos PNG.
Combinar algo como esto con mi herramienta para crear los problemas sería una buena solución que podría estar disponible en una aplicación React durante su ciclo de desarrollo o preparación. Cualquiera que pruebe la aplicación podría activar el panel de informe de problemas y enviar un problema de GitHub.
El único problema con eso por ahora es que la API de GitHub no permite cargar imágenes, por lo que tendrían que estar alojadas en otro lugar y tener el enlace a esa ubicación insertado en esta herramienta, pero definitivamente es una buena mejora.
De nuevo, la aplicación está en https://fast-issues.herokuapp.com/ y si terminas usándola, házmelo saber en los comentarios.