Come creare problemi con GitHub 5 volte più velocemente

I problemi di GitHub sono fantastici per tenere traccia di nuove funzionalità o bug, a chi viene assegnato, classificarli, aggiungerli a progetti e così via. Allo stesso tempo, sono anche piuttosto lenti da creare e crearne un sacco richiede troppo tempo.

Uno dei punti deboli che vedo con i problemi di GitHub al lavoro è che sono ingombranti da creare, in particolare per coloro che non sono sviluppatori o designer, come manager o tester, che vogliono segnalare un bug senza passare attraverso il processo di crearli su GitHub.

Tempo fa ho scritto di un’app che stavo scrivendo per velocizzare la creazione di problemi con GitHub. In realtà ho creato l’app ma poi mi sono dimenticato di scriverne qui, quindi ecco il post sul blog corretto. In questo post vedremo:

2. Scrivere un batch di problemi con GitHub con testo normale
3. Lo stack tecnologico dietro l’app
4. Altre idee per migliorare la creazione di problemi

Perché un’app per creare problemi con GitHub più velocemente?

L’interfaccia utente di GitHub di solito va bene per creare un problema. O due. E va bene per le persone esperte di tecnologia, come sviluppatori o designer. Tuttavia, nella nostra azienda Reconnect, a volte dopo aver sviluppato una nuova funzionalità, chiediamo al nostro personale non tecnico di testarla. E funziona alla grande, perché di solito trovano alcuni problemi. Ma è molto dispendioso per loro andare e passare attraverso l’interfaccia utente dei problemi di GitHub. Questo è ancora più ingombrante quando devono creare più di un problema e probabilmente in repository diversi.

Se quantifichiamo il numero di volte in cui spostiamo la nostra attenzione per creare problemi GitHub una volta raggiunta la pagina per creare un problema nel repository in cui vogliamo crearli, sarebbe qualcosa di più o meno simile a questo:

• inserisci il titolo
• passare alla casella di testo del problema per inserire la descrizione
• vai alla barra laterale per assegnare il problema a qualcuno
• spostati sul blocco Etichette nella barra laterale per aggiungere un’etichetta
• vai e fai clic sul pulsante per creare effettivamente il problema

Ecco 5 volte in cui spostiamo la nostra attenzione da un’area all’altra! Troppa attenzione spostata per un compito che consiste essenzialmente nella scrittura e troppo tempo dedicato alla rifocalizzazione. E se dovessi scrivere un problema in un repository diverso? Devi passare a quel repository in una nuova scheda o in quella corrente e questo è più tempo perso.

Quindi, come puoi creare problemi con GitHub in modo più semplice e veloce? Non sarebbe più facile se potessimo farlo concentrandoci su un singolo luogo senza dover spostare la nostra attenzione più volte?

Scrivere un batch di problemi con GitHub con testo normale

La scrittura è una delle abilità di base nei dispositivi, è più semplice dei gesti tattili. Perché mentre quelli sono specifici per i dispositivi touch, devi usare un mouse o un trackpad su altri. Ma la scrittura di solito è sempre la stessa. E i problemi di GitHub sono di testo, quindi perché non usare il testo per crearli senza mai lasciare la nostra tastiera?

Questa app fa esattamente questo: https://fast-issues.herokuapp.com/

Autorizzi questa app GitHub e puoi iniziare a scrivere problemi in tutti i tuoi repository. Devi solo selezionare un repository in cui vuoi creare un problema e iniziare a scrivere più problemi, uno su ogni riga.

E supporta la scrittura del titolo e della descrizione, assegnarlo ed etichettarlo. Richiede solo il titolo del problema. Il resto è tutto facoltativo. Devi solo seguire una certa convenzione:

• il titolo viene prima
• quindi, un carattere pipe separa gli assegnatari. Ho scelto che fosse così perché almeno hai bisogno di un problema e qualcuno che ci lavori
• un secondo carattere pipe separa la descrizione del problema. Può avere qualsiasi lunghezza, ma non può avere interruzioni di riga perché ciò darebbe inizio a un nuovo problema
• un terzo carattere pipe separa le etichette

Supporta più assegnatari ed etichette separandoli utilizzando una virgola. Quindi in poche parole:

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 volta fatto, si tratta di fare clic su Vai! pulsante e creerà tutti i problemi. Ognuno avrà te come autore. In seguito puoi modificarli per aggiungere immagini o video, meme, qualsiasi cosa.

Se hai bisogno di creare più problemi in un repository diverso, riselezionalo dal menu a discesa e inizia a scrivere quei problemi. Non dovrai più saltare le pagine!

Lo stack tecnologico dietro l’app

Il repository per questa app si trova su https://github.com/eliorivero/fast-issues

Lo stack tecnologico è particolarmente semplice e interamente basato su JavaScript :

• frontend costruito con React
• backend creato con Node.js
• utilizza Express come server
• e Octokit REST una libreria per lavorare con l’API GitHub

Una cosa da tenere a mente è che non vogliamo superare il limite di richieste consentito dall’API GitHub Issues. Consigliano di lasciar trascorrere almeno un secondo tra le richieste, quindi ho sospeso l’esecuzione di 1,5 secondi tra la creazione di ogni problema.

Dal prototipo iniziale che ho realizzato alla versione finale, l’ho cambiato da app GitHub a app OAuth. È perché quest’ultimo ti consente di creare problemi e apparire come l’autore.

Altre idee per migliorare la creazione di problemi

L’ho mostrato a un amico e mi ha detto che aveva l’idea di creare un’estensione di Chrome per fare uno screenshot di un bug, annotarlo e inviarlo come problema con GitHub. Ho pensato che fosse un’ottima idea, quindi ho cercato un modo per fare uno screenshot ma all’interno di un’app React e ho trovato rapidamente html2canvas che permette di fare screenshot e salvarli come file PNG.

Combinare qualcosa del genere con il mio strumento per creare i problemi sarebbe una buona soluzione che potrebbe essere disponibile in un’app React durante il suo ciclo di sviluppo o staging. Chiunque stia testando l’app può attivare il pannello di segnalazione dei problemi e inviare un problema con GitHub.

L’unico problema per ora è che l’API GitHub non consente di caricare immagini, quindi dovrebbero essere ospitate da qualche altra parte e avere il collegamento a quella posizione inserito in questo strumento, ma è sicuramente un buon miglioramento.

Quindi, ancora una volta, l’app è su https://fast-issues.herokuapp.com/ e se finisci per usarla, fammi sapere nei commenti.