Köszönjük, hogy szeretnél közreműködni az Exercism-ben!
Mielőtt pull requestet nyitnál, olvasd el a hogyan készíts remek pull requestet útmutatót, amely a pull requestek nem technikai oldalához nyújt segítséget: célja, hogy jó élményben legyen részed, és hogy ezzel a karbantartó csapatunkat is segítsd.
Ez a dokumentum néhány további, Exercism-specifikus iránymutatást tartalmaz a különböző típusú pull requestekhez.
Pull requestek feladatokhoz
Pull requestet nyitni egy tanulófeladathoz vagy gyakorlófeladathoz ijesztő lehet az ilyen típusú feladatok körüli rengeteg szabály miatt.
Ezért egy karbantartónak akár két-három órába is telhet az áttekintés, és több tucat megjegyzés is születhet belőle.
Hogy segítsünk, egy elsődleges áttekintő fog megjegyzéseket írni a pull requestedhez.
Ne csüggedj az áttekintési megjegyzések számától: teljesen normális, hogy egy feladat több átíráson is átesik, mire olyan formát ölt, amellyel te és az elsődleges áttekintő is elégedett vagy.
Javaslatok
Íme néhány javaslat, amelyekkel még gördülékenyebbé teheted a folyamatot.
Olvasd el a dokumentációt
Mielőtt pull requestet nyitnál egy feladathoz, mindenképp olvasd el a tanulófeladatok dokumentációját, illetve a gyakorlófeladatok dokumentációját.
Ha előre elolvasod a dokumentációt, az hatalmas segítség: kevesebb megjegyzés érkezik majd az áttekintésben, és a pull requested is sokkal hamarabb egyesítik.
Nézd meg a meglévő feladatokat (ha vannak)
Ha a kurzusban már vannak feladatok, szánj egy kis időt arra, hogy megnézd őket: hogyan néznek ki, és hogyan épülnek fel.
Pull requestek gyakorlófeladatokhoz
Gondold át, hogy a változás valóban a problems-specifications tárolóba való-e
A gyakorlófeladatok egyes tartalmai (például a bevezetőjük) a (közös) metaadataikból származnak, amelyeket a problem-specifications tároló határoz meg.
Ha ilyen tartalmat szeretnél frissíteni, gondold át, hogy a változás más kurzusoknak is hasznára válhat-e.
Ha igen, akkor inkább a feladat metaadataihoz nyiss pull requestet a problem-specifications tárolóban.
Általános javaslatok
Tartózkodj a kéretlen áttekintésektől
A pull requestek áttekintését mindig a kurzus egy (vagy több) karbantartója végzi, mivel ők felelnek a tároló minden változásának jóváhagyásáért.
Ha a karbantartók végzik az áttekintést, azzal az is elkerülhető, hogy a pull request szerzője egymásnak ellentmondó visszajelzéseket kapjon.
Természetesen bátran írhatsz megjegyzést, ha segítenél az áttekintésben (különösen nagyobb pull requesteknél), vagy kérdezhetsz, ha valami hibának tűnik.
