Pull requestek

Hogyan készíts nagyszerű pull requestet?


A pull requestek (PR-ek) segítségével küldheted be a javasolt módosításaidat az Exercism kódbázisának valamelyik részébe. Ha ezt olvasod, és épp egy PR-t állítasz össze, köszönjük! Ez az útmutató a PR-ek nem technikai oldalában nyújt segítséget, hogy jó élményben legyen részed, és közben a karbantartó csapatunkat is segítsd.

Mire számíthatsz

A PR-ek folyamata a következő:

  • Beküldesz egy PR-t.
  • Egy vagy több karbantartó átnézi a PR-t, és javaslatokat fűz hozzá. Bizonyos esetekben magáról a PR-ról beszélnek, hogy eldöntsék, egyáltalán érdemes-e hozzáadni.
  • A PR-t beolvasztják, és a weboldalon reputációt kapsz. Vagy bezárják a PR-t.

Hogyan érhetem el, hogy beolvasszák a PR-omat?

Van néhány dolog, amit előre megtehetsz, hogy nagyobb eséllyel olvasszák be a PR-odat minimális módosítással.

A legfontosabb, hogy még a PR beküldése előtt győződj meg róla, hogy a karbantartók szívesen fogadják a módosításaidat. Ezt a legegyszerűbben úgy érheted el, ha először nyitsz egy Issue-t a GitHubon, elmagyarázod benne, mit szeretnél csinálni, és megkérdezed, nyitottak-e a karbantartók ezekre a változtatásokra.

Note

Ha az Exercism weboldalán találsz egy feladatot, akkor nem kell új Issue-t nyitnod. Hozzászólhatsz a meglévő Issue-hoz, hogy dolgozni fogsz rajta, majd nekiláthatsz.

A második dolog, amire figyelj, hogy amikor megnyitod a PR-t, világos leírást adj benne. A leírás nélküli PR-ok hihetetlenül idegesítőek a karbantartóknak, mert nincs kontextusuk, amikor a kódot olvassák. Írd le, miért csináltad a módosításokat, linkeld be az Issue-t, amelyről a PR szól, magyarázd el, milyen kompromisszumokat kellett kötnöd, stb.

Végül ügyelj rá, hogy a PR-od csak egyetlen fejlesztéshez kapcsolódó módosításokat tartalmazzon. Ha több fejlesztésed van, oszd el őket több PR között. Így a karbantartók könnyebben és gyorsabban átnézhetik, és a te dolgodat is megkönnyíti.

Mennyit kell várnom?

A karbantartók általában néhány napon belül átnézik a PR-odat. Kérünk, az első héten ne sürgesd folyamatosan a PR-t további hozzászólásokkal. A karbantartóink önkéntesek és elfoglalt emberek, és amint tudják, sort kerítenek az átnézésére. Ha 7 napon belül nem kaptál választ, akkor a PR-hoz írt új hozzászólásban jelöld meg a(z) @exercism/reviewers csapatot, és ezzel egy nagyobb csapat figyelmét is felhívod rá.


Még egyszer köszönjük a közreműködésedet az Exercism-ben. Reméljük, szórakoztató és értékes élmény lesz!