Påskynda skapandet av GitHub-problem
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. De är också ganska långsamma att skapa, och att skapa ett gäng av dem tar alldeles för lång tid. Så jag skapade ett litet verktyg för att påskynda skapandet av problem och göra det enkelt.
En av smärtpunkterna jag ser med GitHub- problem på jobbet är att de är besvärliga att skapa, särskilt för de som inte är utvecklare, som chefer, designers eller testare, och som helt enkelt vill rapportera ett fel men inte går igenom processen att skapa dem på GitHub.
Att skapa GitHub-problem bör gå snabbt
Så vad är den lättaste interaktionen med datorer, skrivande kanske? Jag vet inte om det är lättast, men det är definitivt lätt. Så i denna enkla textruta kan frågor skrivas och varje rad blir ett problem. Du bara skriver och skriver och lyfter inte händerna från tangentbordet för att ta tag i musen. Du kan också klistra in en lista som skapats i en textredigerare eller ett kalkylblad.
Det har flexibilitet: du kan tilldela problemet till någon (eller många, separera användarnamn med kommatecken) som skiljer titeln från användarnamnet med ett piptecken. Ett annat rör skiljer beskrivningen åt, och ytterligare ett rör separerar etiketterna, som kan vara många, och skiljer dem åt med kommatecken.
Uppdatering: appen är live på https://fast-issues.herokuapp.com/
Teknisk översikt
Detta projekt är ~fortfarande inte helt färdigt men det är redan~ offentligt kl
https://github.com/eliorivero/fast-issues _
Som en allmän översikt:
- det är en GitHub-app som kan installeras i arkivet där problemen kommer att skapas
- har en Node.js-backend med Express som server
- fronten är byggd med React
- nyckelbibliotek för att fungera snabbt med GitHub i Node var https://github.com/octokit/app.js och https://github.com/octokit/rest.js/
En sak att tänka på är att vi inte vill nå API-gränserna. GitHub rekommenderar att du låter minst en sekund gå mellan förfrågningarna. Jag pausade skriptet 1,5 sekunder mellan varje begäran om att skapa problem, det är därför du ser i GIF-bilden ovan att problemen inte skapas direkt.
Fler idéer
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é och 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. Bilden skulle fortfarande behöva lagras på en annan server, för från och med nu är Issues API begränsad och tillåter inte uppladdning av bilder.