Hur man skapar GitHub-problem 5 gånger snabbare

GitHub-problem är fantastiska för att spåra nya funktioner eller buggar, vem som tilldelas, kategorisera dem, lägga till projekt och så vidare. Samtidigt är de också ganska långsamma att skapa och att skapa ett gäng av dem tar för mycket tid.

En av de smärtpunkter jag ser med GitHub- problem på jobbet är att de är besvärliga att skapa, särskilt för de som inte är utvecklare eller designers, som chefer eller testare, som vill rapportera ett fel utan att gå igenom processen att skapa dem på GitHub.

För ett tag sedan skrev jag om en app jag skrev för att påskynda skapandet av GitHub-problem. Jag bygger faktiskt appen men sedan glömde jag att skriva om den här, så här kommer det rätta blogginlägget. I det här inlägget får vi se:

2. Att skriva en grupp GitHub-problem med vanlig text
3. Teknikstacken bakom appen
4. Fler idéer för att förbättra skapandet av problem

Varför en app för att skapa GitHub-problem snabbare?

GitHub-gränssnittet är vanligtvis ok för att skapa ett problem. Eller två. Och det är ok för teknikkunniga människor, som utvecklare eller designers. Men i vårt företag Reconnect, ibland efter att vi utvecklat en ny funktion, ber vi vår icke-tekniska personal att testa den. Och det fungerar utmärkt, eftersom de brukar hitta några problem. Men det är väldigt krävande för dem att gå och hoppa igenom GitHub issues UI. Detta är ännu mer besvärligt när de måste skapa mer än ett problem och förmodligen i olika arkiv.

Om vi ​​kvantifierar antalet gånger vi flyttar vår uppmärksamhet för att skapa GitHub- problem när vi har nått sidan för att skapa ett problem i arkivet där vi vill skapa dem, skulle det vara ungefär så här:

• ange titeln
• flytta till problemtextrutan för att ange beskrivningen
• gå till sidofältet för att tilldela problemet till någon
• flytta till Etiketter-blocket i sidofältet för att lägga till en etikett
• gå och klicka på knappen för att faktiskt skapa problemet

Det är 5 gånger när vi flyttar vår uppmärksamhet från område till område! För mycket uppmärksamhetsförskjutning för en uppgift som i huvudsak är att skriva och för mycket tid ägnas åt att fokusera om. Och vad händer om du måste skriva ett problem i ett annat arkiv? Du måste navigera till det förvaret i en ny flik eller i den nuvarande och det går förlorad mer tid.

Så hur kan du skapa GitHub-problem lättare och snabbare? Skulle det inte vara lättare om vi kunde göra det fokuserat på en enda plats utan att behöva flytta vår uppmärksamhet flera gånger?

Att skriva en grupp GitHub-problem med vanlig text

Att skriva är en av de mest grundläggande färdigheterna i enheter, det är mer grundläggande än ens beröringsgester. För medan de är specifika för pekenheter, måste du använda en mus eller en styrplatta på andra. Men skrivandet är oftast alltid detsamma. Och GitHub-problem är text så varför inte använda text för att skapa dem utan att någonsin lämna vårt tangentbord?

Den här appen gör precis det: https://fast-issues.herokuapp.com/

Du auktoriserar den här GitHub-appen och du kan börja skriva problem i alla dina arkiv. Du behöver bara välja ett arkiv där du vill skapa ett problem och börja skriva flera nummer, en på varje rad.

Och det stöder att skriva titeln och beskrivningen, tilldela den och märka den. Det kräver bara nummertiteln. Resten är valfritt. Du behöver bara följa en viss konvention:

• titeln kommer först
• sedan skiljer ett piptecken åt de tilldelade. Jag valde att det skulle vara så eftersom du åtminstone behöver ett problem och någon som jobbar med det
• ett andra rörtecken separerar problembeskrivningen. Den kan ha vilken längd som helst, men den kan inte ha några radbrytningar eftersom det skulle starta ett nytt problem
• ett tredje rörtecken separerar etiketterna

Den stöder flera tilldelade personer och etiketter genom att separera dem med kommatecken. Så i princip:

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

När det är klart är det en fråga om att klicka på knappen Gå! knappen och den skapar alla problem. Var och en kommer att ha dig som författare. Du kan senare redigera dem för att lägga till bilder eller videor, memes, vad som helst.

Om du behöver skapa fler problem i ett annat arkiv, välj bara om det från rullgardinsmenyn och börja skriva dessa problem. Inget mer att hoppa igenom sidorna!

Teknikstacken bakom appen

Lagret för denna app finns på https://github.com/eliorivero/fast-issues

Den tekniska stacken är särskilt enkel och helt baserad på JavaScript :

• frontend byggd med React
• backend byggd med Node.js
• använder Express som server
• och Octokit REST ett bibliotek för att fungera med GitHub API

En sak att komma ihåg är att vi inte vill överskrida gränsen för begäranden som tillåts av GitHub Issues API. De rekommenderar att man låter minst en sekund gå mellan förfrågningar så jag pausade exekveringen 1,5 sekunder mellan skapandet av varje nummer.

Från den första prototypen jag gjorde till den slutliga versionen ändrade jag den från att vara en GitHub-app till en OAuth-app. Det är för att det senare låter dig skapa problem och framstå som författare.

Fler idéer för att förbättra skapandet av problem

Jag visade detta för en vän och han berättade för mig att han hade den här idén att skapa ett Chrome-tillägg för att ta en skärmdump av ett fel, kommentera det och skicka in det som ett GitHub-problem. Jag tyckte det var en bra idé så jag letade efter ett sätt att ta en skärmdump men inuti en React-app och hittade snabbt html2canvas som gör det möjligt att ta skärmdumpar och spara dem som PNG-filer.

Att kombinera något sånt här med mitt verktyg för att skapa problem skulle vara en bra lösning som skulle kunna vara tillgänglig i en React-app under dess utvecklings- eller iscensättningscykel. Alla som testar appen kan aktivera problemrapporteringspanelen och skicka in ett GitHub-problem.

Det enda problemet med det för tillfället är att GitHub API inte tillåter att ladda upp bilder, så de måste vara värd någon annanstans och ha länken till den platsen insatt i det här verktyget, men det är definitivt en bra förbättring.

Så återigen, appen finns på https://fast-issues.herokuapp.com/ och om du slutar använda den, låt mig veta om det i kommentarerna.