Kuinka luoda GitHub-ongelmia 5 kertaa nopeammin
GitHub-ongelmat ovat fantastisia uusien ominaisuuksien tai vikojen jäljittämiseen, nimettyjen henkilöiden luokitteluun, projekteihin lisäämiseen ja niin edelleen. Samalla ne ovat myös melko hitaita luomaan ja niiden luominen vie liikaa aikaa.
Yksi GitHub -ongelmista työssä havaitsemistani vaikeista on se, että niiden luominen on vaivalloista, erityisesti niille, jotka eivät ole kehittäjiä tai suunnittelijoita, kuten esimiehiä tai testaajia, jotka haluavat ilmoittaa virheestä ilman niiden luomisprosessia. GitHubissa.
Jokin aika sitten kirjoitin sovelluksesta, jota kirjoitin nopeuttaakseni GitHub-ongelmien luomista. Itse asiassa rakensin sovelluksen, mutta sitten unohdin kirjoittaa siitä tänne, joten tässä on oikea blogikirjoitus. Tässä viestissä näemme:
- Kirjoitetaan joukko GitHub-ongelmia pelkällä tekstillä
- Sovelluksen takana oleva tekniikkapino
- Lisää ideoita ongelmien luomisen parantamiseksi
Miksi sovellus luoda GitHub-ongelmia nopeammin?
GitHub-käyttöliittymä on yleensä ok ongelman luomiseen. Tai kaksi. Ja se sopii tekniikan taitaville ihmisille, kuten kehittäjille tai suunnittelijoille. Kuitenkin yrityksessämme Reconnect joskus uuden ominaisuuden kehittämisen jälkeen pyydämme ei-teknistä henkilökuntaa testaamaan sitä. Ja se toimii hyvin, koska he yleensä löytävät joitain ongelmia. Mutta GitHub-ongelmien käyttöliittymän läpikäyminen on heille erittäin työlästä. Tämä on vielä hankalampaa, kun heidän on luotava useampi kuin yksi ongelma ja luultavasti eri arkistoissa.
Jos määritämme kuinka monta kertaa siirrämme huomiomme GitHub – ongelmien luomiseen, kun olemme saavuttaneet sivun luodaksemme ongelman arkistoon, johon haluamme luoda ne, se olisi jotain enemmän tai vähemmän tällaista:
- kirjoita otsikko
- Siirry ongelman tekstiruutuun ja syötä kuvaus
- siirry sivupalkkiin määrittääksesi ongelman jollekin
- Siirry sivupalkin Tunnisteet-lohkoon lisätäksesi tunnisteen
- klikkaa painiketta luodaksesi ongelman
Se on 5 kertaa, kun siirrämme huomiomme alueelta toiselle! Liian paljon huomion siirtymistä tehtävään, joka on pääasiassa kirjoittamista, ja liian paljon aikaa keskittymiseen. Entä jos sinun on kirjoitettava ongelma toiseen tietovarastoon? Sinun on navigoitava kyseiseen arkistoon uudella välilehdellä tai nykyisessä välilehdessä, jolloin menetetään enemmän aikaa.
Joten kuinka voit luoda GitHub-ongelmia helpommin ja nopeammin? Eikö olisi helpompaa, jos voisimme tehdä sen keskittyen yhteen paikkaan ilman, että meidän pitäisi siirtää huomiomme useita kertoja?
Kirjoitetaan joukko GitHub-ongelmia pelkällä tekstillä
Kirjoittaminen on yksi laitteiden perustaidoista, se on perustaidot kuin edes kosketuseleet. Koska vaikka ne koskevat kosketuslaitteita, sinun on käytettävä hiirtä tai ohjauslevyä muissa. Mutta kirjoittaminen on yleensä aina samaa. Ja GitHub-ongelmat ovat tekstiä, joten miksi et käyttäisi tekstiä niiden luomiseen poistumatta näppäimistöstämme?
Tämä sovellus tekee juuri sen: https://fast-issues.herokuapp.com/
Valtuutat tämän GitHub-sovelluksen ja voit alkaa kirjoittaa ongelmia kaikkiin arkistoihin. Sinun tarvitsee vain valita arkisto, johon haluat luoda ongelman, ja alkaa kirjoittaa useita kysymyksiä, yksi jokaiselle riville.
Ja se tukee otsikon ja kuvauksen kirjoittamista, määrittämistä ja merkitsemistä. Se vaatii vain ongelman otsikon. Loput ovat valinnaisia. Sinun tarvitsee vain noudattaa tiettyä käytäntöä:
- otsikko tulee ensin
- sitten putkimerkki erottaa haltijat. Valitsin sen olevan näin, koska tarvitset vähintään ongelman ja jonkun, joka työskentelee sen parissa
- toinen putkimerkki erottaa ongelman kuvauksen. Sen pituus voi olla mikä tahansa, mutta siinä ei voi olla rivinvaihtoja, koska se aiheuttaisi uuden ongelman
- kolmas putkimerkki erottaa tarrat
Se tukee useita valtuutettuja ja tunnisteita erottamalla ne pilkulla. Periaatteessa:
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
Kun se on tehty, sinun on napsautettava Go! -painiketta ja se luo kaikki ongelmat. Jokaisella on sinä kirjoittaja. Voit myöhemmin muokata niitä lisätäksesi kuvia tai videoita, meemejä tai mitä tahansa.
Jos sinun on luotava lisää ongelmia eri arkistoon, valitse se uudelleen pudotusvalikosta ja aloita ongelmien kirjoittaminen. Ei enää sivuilla hyppimistä!
Sovelluksen takana oleva tekniikkapino
Tämän sovelluksen arkisto sijaitsee osoitteessa https://github.com/eliorivero/fast-issues
Tekninen pino on erityisen yksinkertainen ja perustuu kokonaan JavaScriptiin :
- Reactilla rakennettu käyttöliittymä
- Node.js :llä rakennettu tausta
- käyttää Expressiä palvelimena
- ja Octokit REST kirjaston, joka toimii GitHub API:n kanssa
Yksi asia on pidettävä mielessä, että emme halua ylittää GitHub Issues API :n sallimaa pyyntöjen rajaa. He suosittelevat, että pyyntöjen välillä on vähintään yksi sekunti, joten keskeytin suorituksen 1,5 sekuntia kunkin numeron luomisen välillä.
Tein alkuperäisestä prototyypistä lopulliseen versioon, vaihdoin sen GitHub-sovelluksesta OAuth-sovellukseksi. Tämä johtuu siitä, että jälkimmäisen avulla voit luoda ongelmia ja esiintyä kirjoittajana.
Lisää ideoita ongelmien luomisen parantamiseksi
Näytin tämän ystävälle, ja hän kertoi minulle, että hänellä oli idea luoda Chrome-laajennus, joka ottaa kuvakaappauksen virheestä, merkitä siihen ja lähettää sen GitHub-ongelmana. Minusta se oli loistava idea, joten etsin tapaa ottaa kuvakaappaus, mutta React-sovelluksen sisällä löysin nopeasti html2canvasin, jonka avulla voit ottaa kuvakaappauksia ja tallentaa ne PNG-tiedostoina.
Tämänkaltaisen työkaluni yhdistäminen ongelmien luomiseen olisi mukava ratkaisu, joka voisi olla saatavilla React-sovelluksessa sen kehitys- tai vaiheistusjakson aikana. Kuka tahansa sovellusta testaava voi käynnistää ongelmaraportointipaneelin ja lähettää GitHub-ongelman.
Ainoa ongelma tällä hetkellä on, että GitHub-sovellusliittymä ei salli kuvien lataamista, joten ne pitäisi isännöidä jossain muualla ja linkki kyseiseen sijaintiin on lisättävä tähän työkaluun, mutta se on ehdottomasti hyvä parannus.
Joten jälleen, sovellus on osoitteessa https://fast-issues.herokuapp.com/ ja jos päädyt käyttämään sitä, kerro siitä minulle kommenteissa.