Kuidas kasutada GitHubi PR-malle

Kui teete tööd – olenemata sellest, kas see on avatud lähtekoodiga või suletud lähtekoodiga – (kuigi ma tean, et enamik selle saidi lugemist kasutavatest inimestest on seotud avatud lähtekoodiga), kasutate tõenäoliselt mõnda allika juhtimist ja tõenäoliselt on see GitHub.

Paljud teist jälgivad mõnda projekti, panustavad projekti või käsitlete projekti tõmbamistaotlusi. Ja kuidas on lood nende projektidega, mille kallal meeskonnaga töötate?

Võib-olla on teie töövoog midagi sellist:

• loote funktsiooni kallal töötamiseks haru,
• lükkate haru, et täpsustada tehtud tööd, et kolleeg saaks üle vaadata,
• arvustus on liidetud,
• sa jätkad.

Aga mida te tõmbetaotluse malli sisestate? Kas see on iga kord sama või erinev? Mis saab siis, kui suhtekorralduse sisu on seotud millegagi Trellos, Asana, Basecampis või mõnes muus projektijuhtimissüsteemis?

Siin tulevad mängu GitHubi PR-mallid.

GitHubi PR-mallid

Nende kohta saate lehelt kõike lugeda, kuid siin on sisu (pole mõeldud):

Probleemi on raske lahendada, kui olulised üksikasjad puuduvad. Nüüd saavad projekti hooldajad lisada projektidele probleemide ja tõmbetaotluste malle, aidates kaasautoritel lõime alguses õigeid üksikasju jagada

Ja idee on lihtne: loome probleemide jaoks malle ja loome teistele päringuid, mis pakuvad teatud tasemel teavet, mille nad peavad enne probleemi või tõmbetaotluse esitamist täitma.

See aitab meil kui hooldajatel teada, millist teavet me vajame enne selle uurimist. Lisaks võib see võimaldada meil linkida varasemale väljaandele, eelmisele piletile või millelegi, mis on projektiga seotud.

Näiteks oletame, et töötate projekti kallal ja soovite lisada järgmise teabe.

• lühike kirjeldus selle kohta, mida PR teeb, et hooldaja ei peaks arvama,
• PR staatus selle kohta, kas see peaks olema ühendamiseks valmis või kui see on alles väljatöötamisel, kuid valmis ülevaatamiseks,
• link teie projektijuhi piletile, mille kohta PR on asjakohane.

Ma ei ütle, et see on vajalik teave, kuid see on midagi, mida oleme kasutanud ja olen leidnud, et see on kasulik (ja on tore näha, et aja jooksul tehakse rohkem täiustusi ).

Aga kuidas me seda kasutame?

Sait on üsna selge, kuid see on tõesti lihtne. Teil on vaja oma projekti kataloogis või projekti kataloogis järgmisi faile. githubi kataloog:

• ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE

Kõik need peaksid olema allahindlusfailid, mis näitavad täpselt välja, mida otsite oma kaastöölistele, kui nad teie projekti mingil moel kaasa aitavad.

Ja siis, kui kasutaja soovib probleemist teatada või tõmbetaotlust luua, on ta küsinud mallist pärinevat teavet.

Tore, kas pole?

Seda pole palju, aga…

Võib-olla te ei arva, et see on palju, kuid on üsna lihtne aidata parandada projekti tuleva teabe kvaliteeti, lasta oma kaastöötajatel mõelda, mida nad projekti panevad, ja seejärel vastavalt reageerida.

Lisaks aitab see teil ja teie ülejäänud meeskonnal mõista, mis on ülevaatamisel, ja valmistuda muudatusteks, mis nende projektidega töötades võivad ette tulla.