Kuinka käyttää GitHub PR-malleja

Jos teet jotain työtä – riippumatta siitä onko se avoimen lähdekoodin vai suljettu lähdekoodi – (vaikka tiedän, että useimmat tämän sivuston lukijat ovat mukana avoimessa lähdekoodissa), käytät todennäköisesti lähdekoodia, ja se on luultavasti GitHub.

Monet teistä joko seuraatte projektia, osallistutte projektiin tai käsittelette projektin vetopyyntöjä. Entä ne projektit, joiden parissa työskentelet tiimin kanssa?

Ehkä työnkulkusi on jotain tällaista:

• luot haaran ominaisuuden käsittelemiseksi,
• työnnät haaraa yksityiskohtaisesti työstäsi vertaisarvioitavaksi,
• arvostelu on yhdistetty,
• sinä jatkat.

Mutta mitä laitat vetopyynnön malliin? Onko se sama joka kerta vai onko se erilainen? Entä jos PR:n sisältö liittyy johonkin Trellossa, Asanassa, Basecampissa tai muussa projektinhallintajärjestelmässä?

Siellä GitHubin PR-mallit tulevat peliin.

GitHub PR-mallit

Voit lukea niistä kaikki sivulla, mutta tässä on ydin (ei sanailua):

On vaikea ratkaista ongelmaa, kun tärkeitä yksityiskohtia puuttuu. Nyt projektien ylläpitäjät voivat lisätä projekteihin malleja ongelmia ja vetopyyntöjä varten, mikä auttaa avustajia jakamaan oikeat tiedot säikeen alussa

Ja idea on yksinkertainen: Luomme malleja ongelmille ja vedämme pyyntöjä muille, jotka tarjoavat tietyn tason tietoja, jotka heidän on täytettävä ennen ongelman tai vetopyynnön lähettämistä.

Tämä auttaa meitä ylläpitäjinä tietämään, mitä tietoja tarvitsemme ennen niiden tutkimista. Lisäksi se voi antaa meille mahdollisuuden linkittää aikaisempaan numeroon, aikaisempaan lippuun tai ennen kaikkea projektiin liittyvään.

Esimerkkinä, oletetaan, että työskentelet projektin parissa ja haluat sisällyttää siihen seuraavat tiedot:

• lyhyt kuvaus PR:n toiminnasta, jotta ylläpitäjän ei tarvitse arvailla,
• PR:n tila siitä, pitäisikö sen olla valmis yhdistettäväksi vai onko se vielä kehitteillä, mutta valmis tarkistettavaksi,
• linkki lippuun projektipäällikkössäsi, johon PR on merkityksellinen.

En väitä, että tämä on vaadittu tieto, mutta olemme käyttäneet niitä ja olen todennut hyödyllisiksi (ja on mukava nähdä, että ajan myötä on tehty lisää parannuksia ).

Mutta kuinka käytämme tätä?

Sivusto on melko selkeä, mutta se on todella yksinkertainen. Tarvitset seuraavat tiedostot projektisi hakemistoon tai projektisi hakemistoon. github- hakemisto:

• ISSUE_MALLINE
• PULL_REQUEST_MALLINE

Kaikkien näiden pitäisi olla merkintätiedostoja, jotka paljastavat tarkalleen, mitä etsit avustajiasi sisällytettäväksi aina, kun he osallistuvat projektiisi jollain tavalla.

Ja sitten aina, kun käyttäjä haluaa ilmoittaa ongelmasta tai luoda vetopyynnön, hän on kehottanut käyttämään mallin tietoja.

Hienoa, eikö?

Se ei ole paljon, mutta…

Et ehkä ajattele, että se on paljon, mutta on melko helppoa auttaa parantamaan projektiin tulevan tiedon laatua, pyytää osallistujia miettimään, mitä he laittavat projektiin, ja sitten reagoida vastaavasti.

Lisäksi se auttaa sinua ja muuta tiimiäsi ymmärtämään, mitä tarkistetaan, ja valmistautua kaikkiin muutoksiin, joita saattaa tulla heidän tielleen työskennellessään näiden projektien parissa.